mirror of
https://github.com/hazemKrimi/crimson-quirks-ui.git
synced 2026-05-01 18:20:28 +00:00
Update README and package.json
This commit is contained in:
@@ -2,6 +2,28 @@
|
|||||||
|
|
||||||
A UI component library utilizing Vite and Storybook to be used in my personal projects.
|
A UI component library utilizing Vite and Storybook to be used in my personal projects.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
You need to have `react` and `styled-components` already installed as they are peer dependencies.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install the package using `yarn` run the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn add crimson-quirks-ui
|
||||||
|
```
|
||||||
|
|
||||||
|
You can use any other package manager you prefer like `npm`.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
If you want to add more components for example and you want a development environment you can use `storybook`:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn storybook
|
||||||
|
```
|
||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
|
|
||||||
I used this [Starter Component Library Repo](https://github.com/dev-divein/react-storybook-tailwind) as a reference.
|
I used this [Starter Component Library Repo](https://github.com/dev-divein/react-storybook-tailwind) as a reference.
|
||||||
|
|||||||
+2
-3
@@ -6,9 +6,8 @@
|
|||||||
"module": "dist/crimson-quirks-ui.es.js",
|
"module": "dist/crimson-quirks-ui.es.js",
|
||||||
"default": "dist/crimson-quirks-ui.umd.js",
|
"default": "dist/crimson-quirks-ui.umd.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"files": [
|
"files": ["dist"],
|
||||||
"dist"
|
"keywords": ["react", "styled-components", "storybook", "ui-library", "component-library"],
|
||||||
],
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "vite build",
|
"build": "vite build",
|
||||||
"lint": "eslint src",
|
"lint": "eslint src",
|
||||||
|
|||||||
Reference in New Issue
Block a user