Add README.md

README.md

@@ -0,0 +1,37 @@
+# Vite React Component Library Starter
+
+This is a starter template for creating React component libraries using Vite. It includes a robust set of features to help you develop, test, and build your library efficiently.
+
+## Features
+
+- React: A JavaScript library for web and native user interfaces.
+- TypeScript: A strongly typed superset of JavaScript.
+- Tailwind: A utility-first CSS framework.
+- Storybook: A frontend workshop for building UI components and pages in isolation.
+- Vite: A next generation frontend tooling that runs and builds your library incredibly fast.
+- Vitest: A next generation testing framework.
+- ESLint: A tool that finds and fixes problems in your code.
+- Prettier: A code formatter.
+- Husky: A pre-commit hook.
+- Github Action: A tool that deploys your Storybook to GitHub page automatically.
+
+## Get Started
+
+1. Clone this repository
+2. Install dependencies using `npm i` (or `pnpm i` if you like)
+
+## Scripts
+
+`dev`: Starts the local Storybook server, use this to develop and preview your components.
+`test`: Runs all your tests with vitest.
+`test:watch`: Runs tests in watch mode.
+`test:ui`: Runs tests with a UI.
+`test:coverage`: Runs tests and generates a coverage report.
+`build`: Builds your Storybook as a static web application.
+`build:lib`: Builds your component library with Vite.
+`lint`: Runs ESLint.
+`format`: Formats your code with Prettier.
+
+## License
+
+MIT

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "vite-react-component-library-template",
+  "name": "vite-react-component-library-starter",
   "private": true,
   "version": "0.0.0",
   "description": "A template for creating React component libraries with Vite, Tailwind, and Storybook.",