Document <Text> component (#36)

vadimdemedes · Aug 27, 2017 · 6ae7acc · 6ae7acc
1 parent 9c44d8a
commit 6ae7acc
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -519,6 +519,20 @@ const Demo = (
 );
 ```
 
+The `<Text>` compoment is a simple wrapper around [the `chalk` API](https://github.com/chalk/chalk#api) it supports all of the chalk methods as `props`.
+
+```jsx
+import {Text} from "ink"
+
+<Text rgb={[255, 255, 255]} bgKeyword="magenta">
+	Hello!
+</Text>
+
+<Text hex="#000000" bgHex="#FFFFFF">
+	Hey there
+</Text>
+```
+
 ## License
 
 MIT © [Vadim Demedes](https://github.com/vadimdemedes)