Skip to content

Commit

Permalink
Merge pull request #41 from catho/update-readme
Browse files Browse the repository at this point in the history
docs(README): Update README.md
  • Loading branch information
ddsilva authored Apr 5, 2019
2 parents fa98f99 + 00a8bf5 commit 97c7134
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Maintainers

- Alan Oliveira ([[email protected]](mailto:[email protected]?Subject=Candidate%20Home%20Page%20Issue))
- Allysson dos Santos ([[email protected]](mailto:[email protected]?Subject=Candidate%20Home%20Page%20Issue))
- Daniel da Silva ([[email protected]](mailto:[email protected]?Subject=Candidate%20Home%20Page%20Issue))
- Gabriel Gonçalves Daltoso ([[email protected]](mailto:[email protected]?Subject=Candidate%20Home%20Page%20Issue))
- Luiz Henrique Zanao Kota ([[email protected]](mailto:[email protected]?Subject=Candidate%20Home%20Page%20Issue))
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ This is the default pack of components and layout principles that dictates Catho
It can be installed via npm or yarn.

```sh
yarn add @cathodevel/quantum
yarn add @catho/quantum
```

To use a component, it need to be imported in your project:

```js
import { Button } from 'quantum';
import { Button } from '@catho/quantum';
// or
import Button from '@catho/quantum/Button';
```

You can find a list of all available components and full documentation on how to use them at our [Storybook](https://catho.github.io/quantum/)

## Contributing

- Check the [issues](https://github.com/catho/quantum/issues) to ensure that there is not someone already working on it
Expand Down

0 comments on commit 97c7134

Please sign in to comment.