Update docs

vtex-apps · Oct 2, 2019 · 2d18697 · 2d18697
1 parent 52fa2dd
commit 2d18697
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Utility for generating CSS handles for store components.
 
 🚧 Under Construction 🚧
 
-### Usage
+## Usage
 
 ```tsx
 import React, { FunctionComponent } from 'react'
@@ -35,3 +35,14 @@ const Component: FunctionComponent = () => {
   )
 }
 ```
+
+### Options
+
+- `migrationFrom`: Adds additional CSS handles for cases where a component is migrating from another app.
+
+#### Usage:
+```tsx
+const CSS_HANDLES = ['container']
+const handles = useCssHandles(CSS_HANDLES, { migrationFrom: '[email protected]' })
+// Returns { container: 'vtex-current-app-0-x-container vtex-store-components-2-x-container' }
+```
diff --git a/docs/README.md b/docs/README.md
@@ -4,7 +4,7 @@ Utility for generating CSS handles for store components.
 
 🚧 Under Construction 🚧
 
-### Usage
+## Usage
 
 ```tsx
 import React, { FunctionComponent } from 'react'
@@ -35,3 +35,14 @@ const Component: FunctionComponent = () => {
   )
 }
 ```
+
+### Options
+
+- `migrationFrom`: Adds additional CSS handles for cases where a component is migrating from another app.
+
+#### Usage:
+```tsx
+const CSS_HANDLES = ['container']
+const handles = useCssHandles(CSS_HANDLES, { migrationFrom: '[email protected]' })
+// Returns { container: 'vtex-current-app-0-x-container vtex-store-components-2-x-container' }
+```