From 50eb1fa6fe909207458c1f08f73b95aac9e33d83 Mon Sep 17 00:00:00 2001
From: Hazem Krimi <me@hazemkrimi.tech>
Date: Tue, 1 Apr 2025 19:48:10 +0100
Subject: [PATCH] Update README and package.json

---
 README.md    | 22 ++++++++++++++++++++++
 package.json |  5 ++---
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index bfdca8e..b9b7147 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/package.json b/package.json
index d87eeea..09baec4 100644
--- a/package.json
+++ b/package.json
@@ -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",