@wavv/ui 2.0.0-alpha.1 → 2.0.0-alpha.100

package/README.md

@@ -55,6 +55,28 @@ const App = () => {
 
 Documentation can be found at [ui.wavv.com](https://ui.wavv.com/)
 
+For new v2 components, `pnpm storybook` can be ran to bring up more detailed documentation for props.
+
+## Contributing
+
+### CLI
+
+When a change is ready to be pushed to the library and published to NPM, the best method is to use the cli.
+
+1. `pnpm cli`
+2. Bump version (stick with the pre-release alpha version for now).
+3. Document what changes are going out by answering the cli prompts.
+4. You can answer "no" to the prompt for creating a new branch.
+5. The final prompt asks if you would like to publish to npm. This will handle the alpha version tag for you.
+
+### Manual
+
+If something goes wrong with using the CLI, or another change needs to be added to the build before publishing to npm, there are a couple different scripts that can be run to manually build and publish the library.
+
+1. `pnpm build:lib` will run another build for the library, ensuring your new changes are included.
+2. Make sure the version in `package.json` is the new version that should go out if it hasn't already been changed by the cli prompts.
+3. `pnpm pub:alpha` will publish to npm with the correct `alpha` tag since we are sticking to a pre-release tag for now.
+
 ## License
 
 This project is licensed under the terms of the MIT license.