design-system-silkhaus 0.0.6 → 0.0.8-3.beta.2

package/README.md

@@ -22,6 +22,15 @@ This is a starter template for creating React component libraries using Vite. It
 3. To see storybook locally use `npm run dev` (or `pnpm dev` if you like)
 4. To see storybook locally use `npm run dev` (or `pnpm dev` if you like)
 
+## Development
+
+1. Create package for the component
+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
+
 ## Scripts
 
 - `dev`: Starts the local Storybook server, use this to develop and preview your components.
@@ -34,6 +43,18 @@ This is a starter template for creating React component libraries using Vite. It
 - `lint`: Runs ESLint.
 - `format`: Formats your code with Prettier.
 
+## Publish Dev
+
+- `npm run build:lib` - Build the lib, this has to done before publishing
+- `npm version <version>.beta.x` - run this command to update package version for testing
+- `npm publish --access=public --tag beta` - To publish lib with beta tag
+
+## Publish Prod
+
+- `npm run build:lib` - Build the lib, this has to done before publishing
+- - `npm version <version>` - run this command to update package version for testing
+- `npm publish --access=public --tag latest` - To publish lib with latest tag
+
 ## License
 
 MIT