diff --git a/README.md b/README.md index e5245d4..cd2530d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ -# Ekaterinburg UI +# ekb + +[![npm version](https://badge.fury.io/js/ekb.svg)](https://www.npmjs.com/ekb) + +React components for ekaterinburgdev projects + +**[Storybook](https://ekaterinburg-ui.vercel.app/)** + + -## Develop -```bash -pnpm i -pnpm storybook -``` -## Publish +## Development + +1. Install [Node.js](https://nodejs.org/en/download/) and [pnpm](https://www.npmjs.com/package/pnpm#user-content-usage) + +2. Install dependencies + ``` -pnpm run build -npm publish +pnpm i ``` -## Build static site with ui -```bash -pnpm build-storybook +3. Run local server + +``` +pnpm start ```