chore: improve get started (#509)

* chore: improve get started * fix: use react markdown to render markdown file * fix: use storybook components with react markdown
nearform · Jun 25, 2024 · e25aaf8 · e25aaf8
1 parent 1101bdb
commit e25aaf8
Show file tree

Hide file tree

Showing 4 changed files with 418 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -48,3 +48,21 @@ To run Storybook tests for the project, run:
 ```js
 npm run test-storybook
 ```
+
+## Usage
+
+Just import:
+
+```js
+import { Button, ButtonGroup } from '@nearform/quantum'
+```
+
+And use:
+
+```jsx
+<ButtonGroup>
+  <Button>One</Button>
+  <Button>Two</Button>
+  <Button>Three</Button>
+</ButtonGroup>
+```