Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
josepjaume committed Apr 9, 2024
1 parent 235264f commit 29bd978
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 29bd978

Please sign in to comment.