design-system-silkhaus 1.1.0-beta.weekly-cleaning.3 → 1.1.0

package/README.md

@@ -1,20 +1,3 @@
-# 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
@@ -25,13 +8,13 @@ This is a starter template for creating React component libraries using Vite. It
 
 ## Development
 
-1. Create package for the component
+1. Create folder for the component under
 2. index.ts file to be created inside package to export the component
-3. component.tsx file with the actual code for the component
-4. component.stories.tsx file for the story book
-5. [OPTIONAL] style.css can be used inside the package
-6. [IMP] Export the component in the top level lib/index.tsx file to publish it in NPM
-7. Please refer to our front-end development guide [here](https://docs.google.com/document/d/12APeDrwgF65WzYF_2iZMpptFKDieqQFk4BlrBD87fP4)
+3. <Component>.tsx file with the actual code for the component
+4. <Component>.stories.tsx file for the story book
+5. [OPTIONAL] style.scss can be used inside the package. This should only be needed under rare cases as our styling should only be done through tailwind utlity classes
+6. [IMP] Export the component in the top level lib/index.tsx file so that its available to be imported from published library
+7. [IMP] Please refer to our front-end development guide [here](https://docs.google.com/document/d/12APeDrwgF65WzYF_2iZMpptFKDieqQFk4BlrBD87fP4)
 
 ## Scripts
 
@@ -43,7 +26,9 @@ This is a starter template for creating React component libraries using Vite. It
 - `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.
+- `format:check`: Check prettier formatting
+- `format:fix`: Fixes all prettier formatting issues
+- `knip`: Checks for unsused dependencies and exports.
 
 ## Publish Dev