NCM-2 update readme and package description

README.md

@@ -1 +1,45 @@
-# Next classnames minifier
+# Next classnames minifier
+
+Library for configuring style _(css/scss/sass)_ modules to generate compressed classes
+
+## Reasons
+*Compressing classes* can reduce the size of the generated html and css by up to *20%*, which will have a positive effect on page rendering and metrics (primarily [FCP](https://web.dev/first-contentful-paint/))
+
+## Installation
+
+**Using npm:**
+```bash
+npm i next-classnames-minifier
+```
+
+**Using yarn:**
+```bash
+yarn add next-classnames-minifier
+```
+
+## Usage
+
+Create `next.config.js` file in your project and apply the library.
+
+**Base:**
+```js
+const withClassnamesMinifier = require('next-classnames-minifier').default;
+
+module.exports = withClassnamesMinifier({
+    // next.js config
+});
+```
+
+**With `next-compose-plugins`:**
+```js
+const withClassnamesMinifier = require('next-classnames-minifier').default;
+const withPlugins = require('next-compose-plugins');
+
+module.exports = withPlugins([
+    [withClassnamesMinifier]
+], nextConfig);
+```
+
+## License
+
+[MIT](https://github.com/vordgi/next-classnames-minifier/blob/main/LICENSE)

package.json

@@ -1,17 +1,28 @@
 {
   "name": "next-classnames-minifier",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.0.2",
+  "description": "Library for configuring style modules to generate compressed classes",
   "main": "dist/withClassnamesMinifier.js",
   "types": "dist/withClassnamesMinifier.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "start": "ts-node index.ts",
     "build": "tsc"
   },
-  "keywords": [],
+  "keywords": [
+    "next",
+    "next.js",
+    "classname",
+    "class",
+    "minify",
+    "compress",
+    "cut",
+    "css",
+    "sass",
+    "scss",
+    "modules"
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/vordgi/next-classnames-minifier.git"