add additional text field docs

microsoft · May 29, 2020 · 33879d2 · 33879d2
1 parent 2287ae6
commit 33879d2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/web-components/fast-foundation/src/text-field/README.md b/packages/web-components/fast-foundation/src/text-field/README.md
@@ -5,6 +5,8 @@ sidebar_label: fast-text-field
 custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/text-field/README.md
 ---
 
+An implementation of a [text field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input/text) as a form-connected web-component. The `fast-text-field` supports two visual apperances, outline and filled, with the control defaulting to the outline appearance.
+
 ## Applying Custom Styles
 
 ```ts
@@ -21,4 +23,10 @@ import { TextFieldStyles as styles } from "./text-field.styles";
     },
 })
 export class FASTTextField extends TextField {}
+```
+
+## Usage
+
+```html
+<fast-text-field appearance="filled" placeholder="user@email.com">Email</fast-text-field>
 ```