From 29bd9784952bb1011d64bf2e134615b2c05c9ff0 Mon Sep 17 00:00:00 2001 From: Josep Jaume Rey Peroy Date: Tue, 9 Apr 2024 22:00:46 +0200 Subject: [PATCH] Improve readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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