✨ feat: add new monorepo params to work with monorepo

arvinxx · Dec 24, 2022 · 6fdbc7f · 6fdbc7f
1 parent 8a50b94
commit 6fdbc7f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/packages/release-config/README.md b/packages/release-config/README.md
@@ -6,8 +6,23 @@ shareable [semantic-release][semantic-release] configuration for gitmoji commit
 
 ## How to use
 
+### Basic Usage
+
+```js
+// .releaserc.js
+module.exports = {
+  extends: ['semantic-release-config-gitmoji'],
+};
+```
+
+### Create your config
+
 ```js
+const { createConfig } = require('semantic-release-config-gitmoji/lib/createConfig');
+
+const config = createConfig({ monorepo: true });
 
+module.exports = config;
 ```
 
 ## License

diff --git a/packages/release-config/package.json b/packages/release-config/package.json
@@ -21,6 +21,7 @@
   "license": "MIT",
   "author": "Arvin Xu <arvinx@foxmail.com>",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],