diff --git a/README.md b/README.md index ce5ca3cc..0d3c4b9d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,28 @@ [factorialco.github.io/factorial-one/](https://factorialco.github.io/factorial-one/) +## Usage + +In your react project: + +```bash +$ npm install git+https://github.com/factorialco/factorial-one#release +``` + +Then, in your react files: + +```tsx +// In your `main.tsx` file or any top-level component +import "@factorialco/factorial-one/dist/styles.css" + +// In any of your components +import { Button } from "@factorialco/factorial-one" +``` + +And that's it! + +## Development + How to run: ```bash