improve docs; add metadata

.changeset/weak-wasps-listen.md

@@ -0,0 +1,5 @@
+---
+'@icapps/nestkit-common': patch
+---
+
+Initial release

packages/common/README.md

@@ -1,8 +1,14 @@
 # `@icapps/nestkit-common`
 
-This package contains common utilities, enums, constants,...
+Common utilities, enums, constants,...
 
-## API
+## Installation
+
+```bash
+npm install @icapps/nestkit-common
+```
+
+## Usage
 
 ### Utilities
 
@@ -11,6 +17,9 @@ This package contains common utilities, enums, constants,...
 ```typescript
 // app.config.ts
 
+...
+import { validateConfig } from '@icapps/nestkit-common';
+
 class AppConfig {
   @Expose({ name: 'NODE_ENV' })
   @IsEnum(Environment)
@@ -37,3 +46,14 @@ enum Environment {
   Test = 'test',
 }
 ```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[ISC](LICENSE)

packages/common/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@icapps/nestkit-common",
   "version": "0.0.0",
+  "description": "Common utilities, enums, constants,...",
+  "keywords": [
+    "nestjs"
+  ],
+  "homepage": "https://github.com/icapps/NestKit#readme",
+  "bugs": "https://github.com/icapps/NestKit/issues",
+  "license": "ISC",
+  "author": "icapps <info@icapps.com> (https://icapps.com)",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "license": "ISC",
-  "publishConfig": {
-    "access": "public"
-  },
+  "repository": "github:icapps/NestKit",
   "scripts": {
     "build": "tsup ./src/index.ts --format cjs,esm --dts",
     "dev": "npm run build -- --watch",
@@ -23,5 +28,8 @@
     "tsconfig": "*",
     "tsup": "^7.2.0",
     "typescript": "^4.5.2"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }