Update README and package.json

This commit is contained in:
2025-04-01 19:48:10 +01:00
parent a8e985f182
commit 50eb1fa6fe
2 changed files with 24 additions and 3 deletions
+22
View File
@@ -2,6 +2,28 @@
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
I used this [Starter Component Library Repo](https://github.com/dev-divein/react-storybook-tailwind) as a reference.
+2 -3
View File
@@ -6,9 +6,8 @@
"module": "dist/crimson-quirks-ui.es.js",
"default": "dist/crimson-quirks-ui.umd.js",
"types": "dist/index.d.ts",
"files": [
"dist"
],
"files": ["dist"],
"keywords": ["react", "styled-components", "storybook", "ui-library", "component-library"],
"scripts": {
"build": "vite build",
"lint": "eslint src",