docs update (#652)

Author: rndD

README.md

@@ -2,16 +2,17 @@
 
 The home of the ClickHouse design system and component library. Click UI is in very early development and subject to change, we do not recommend using it for production purposes.
 
-### Using Click UI in an external app
+## Using Click UI in an external app
 
 Click UI has been tested in NextJS, Gatsby, and Vite. If you run into problems using it in your app, please create an issue and our team will try to answer.
+
 1. Navigate to your app's route and run
    `npm i @clickhouse/click-ui`
    or
    `yarn add @clickhouse/click-ui`
 2. Make sure to wrap your application in the Click UI `ClickUIProvider`, without doing this, you may run into issues with styled-components. Once thats done, you'll be able to import the individual components that you want to use on each page. Here's an example an `App.tsx` in NextJS.
 
-```ts
+```typescript
 import { ClickUIProvider, Text, ThemeName, Title, Switch } from '@clickhouse/click-ui'
 
 function App() {
@@ -34,7 +35,7 @@ function App() {
 export default App
 ```
 
-### To develop this library locally 🚀
+## To develop this library locally 🚀
 
 1. Clone this repo, cd into the `click-ui` directory
 2. To install dependencies, run `npm i`
@@ -43,3 +44,9 @@ export default App
 5. To run Storybook locally, run `npm run storybook` and navigate to https://localhost:6006
 
 Enjoy!
+
+## Releases and Versions
+
+New versions and release notes are available at [GitHub Releases](https://github.com/ClickHouse/click-ui/releases).
+
+To create a new release and publish a new version, follow the instructions in [publish.md](./docs/publish.md).

docs/images/publish1.png

@@ -0,0 +1,9 @@
+# How to create new release and publish a new Click-UI package version to NPM
+
+1. Navigate to the [Release page](https://github.com/ClickHouse/click-ui/releases) and check the latest release. It might already contain the changes you need, making a new version unnecessary.
+2. Draft a [new release](https://github.com/ClickHouse/click-ui/releases/new).
+3. Create a tag for the release. The new version should be an increment from the latest released version. ![Create tag instruction](./images/publish1.png)
+4. Generate release notes. ![Release notes instruction](./images/publish2.png)
+5. Publish the release. ![Release](./images/publish3.png)
+6. Wait until the [GitHub Actions](https://github.com/ClickHouse/click-ui/actions) complete.
+7. Verify that the new version is published on [npm](https://www.npmjs.com/package/@clickhouse/click-ui).