🔖 Release v1.0.0

frinyvonnick · Oct 25, 2018 · 9b0eb6b · 9b0eb6b
1 parent e1037c9
commit 9b0eb6b
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 61 deletions.
diff --git a/lerna.json b/lerna.json
@@ -5,5 +5,5 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.0.0"
+  "version": "1.0.0"
 }
diff --git a/packages/gitmoji-changelog-cli/README.md b/packages/gitmoji-changelog-cli/README.md
@@ -38,58 +38,8 @@ Here the recommended workflow to generate your changelog file using `gitmoji-cha
 6. Tag your release: `git tag -a v1.0.0 -m "v1.0.0"` (or create a Github release)
 7. Push to the remote `git push`
 
-## Customize your changelog
-
-By default when you generate your changelog with `gitmoji-changelog`, the following mapping is used to group commits :
-> [groupMapping.js](packages/gitmoji-changelog-core/src/groupMapping.js).
-
-*// TODO: How to override the default mapping with it's own.*
-
 ## Usage
 
-### CLI
-
-Full CLI documentation in [gitmoji-changelog-cli package](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-cli#gitmoji-changelog-cli)
-
-### API
-
-Full API documentation in [gitmoji-changelog-core package](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-core#gitmoji-changelog-core)
-
-## Develop and contribute
-
-### Setup
-
-```bash
-git clone git@github.com:frinyvonnick/gitmoji-changelog.git
-
-cd gitmoji-changelog && yarn
-```
-
-We are using lerna and yarn workspaces to split the library in modules:
-- [gitmoji-changelog-cli](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-cli) - the full-featured command line interface
-- [gitmoji-changelog-core](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-core) - the core lib generating changelog
-- [gitmoji-changelog-markdown](https://github.com/frinyvonnick/gitmoji-changelog/tree/master/packages/gitmoji-changelog-markdown) - the markdown changelog file writer
-
-**Execute it locally:**
-
-```
-node [path-to-gitmoji-changelog-folder]/packages/gitmoji-changelog-cli/src/index.js
-```
-
-**Execute tests:**
-
-We are using [jest](https://jestjs.io/) to manage unit testing.
-
-```bash
-yarn test
-# or
-yarn test --watch
-```
-
-**Execute linter:**
-
-We are using [airbnb-base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) as linter:
-
-```bash
-yarn lint
+```js
+gitmoji-changelog --help
 ```
diff --git a/packages/gitmoji-changelog-cli/package.json b/packages/gitmoji-changelog-cli/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@gitmoji-changelog/cli",
-  "version": "0.0.1",
+  "name": "gitmoji-changelog",
+  "version": "1.0.0",
   "keywords": [
     "gitmoji",
     "generate",
@@ -14,8 +14,8 @@
   ],
   "description": "Gitmoji Changelog CLI",
   "main": "src/index.js",
-  "engines" : {
-    "node" : ">=10"
+  "engines": {
+    "node": ">=10"
   },
   "bin": {
     "gitmoji-changelog": "./src/index.js"
@@ -31,8 +31,12 @@
   },
   "homepage": "https://github.com/frinyvonnick/gitmoji-changelog#readme",
   "dependencies": {
-    "@gitmoji-changelog/core": "0.0.1",
-    "@gitmoji-changelog/markdown": "0.0.1",
+    "@gitmoji-changelog/core": "^1.0.0",
+    "@gitmoji-changelog/markdown": "^1.0.0",
     "yargs": "^12.0.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   }
 }
diff --git a/packages/gitmoji-changelog-core/package.json b/packages/gitmoji-changelog-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gitmoji-changelog/core",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Core tool that transform raw commits into a nice json structure",
   "main": "src/index.js",
   "engines": {

diff --git a/packages/gitmoji-changelog-markdown/package.json b/packages/gitmoji-changelog-markdown/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gitmoji-changelog/markdown",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Gitmoji Changelog markdown formatter",
   "main": "src/index.js",
   "bin": {