Merge 42f854e into 81e03b0

README.md

@@ -9,24 +9,28 @@ _Having problems? want to contribute? join our [community slack](http://devtools
 
 > Generate a CHANGELOG from git metadata
 
-It's recommended you use the high level [standard-version](https://github.com/conventional-changelog/standard-version) library, which handles the entire tagging and CHANGELOG
-generation process.
-
-Alternatively, the [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) allows you to generate a CHANGELOG from the
-command line.
-
 ## About this Repo
 
 The conventional-changelog repo is managed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md); it's composed of many npm packages.
 
 The original `conventional-changelog/conventional-changelog` API repo can be
 found in [packages/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog).
 
+## Get started
+
+It's recommended you use the high level [standard-version](https://github.com/conventional-changelog/standard-version) library, which handles the entire tagging and CHANGELOG
+generation process.
+
+Alternatively, the [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) allows you to generate a CHANGELOG from the command line.
+
+You can also use one of the plugins if you are already using the tool:
+
 ## Plugins Supporting Conventional Changelog
 
 - [grunt](https://github.com/btford/grunt-conventional-changelog)
 - [gulp](https://github.com/conventional-changelog/gulp-conventional-changelog)
 - [atom](https://github.com/conventional-changelog/atom-conventional-changelog)
+- [vscode](https://github.com/axetroy/vscode-changelog-generator)
 
 ## Modules Important to Conventional Changelog Ecosystem
 
@@ -36,8 +40,7 @@ found in [packages/conventional-changelog](https://github.com/conventional-chang
 - [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
 - [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using
 - [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
-- [commitlint](https://github.com/marionebl/commitlint) - Lint commit messages
-- [vscode-changelog-generator](https://github.com/axetroy/vscode-changelog-generator) - vscode extension
+- [commitlint](https://github.com/conventional-changelog/commitlint) - Lint commit messages
 
 ## Node Support Policy
 

packages/conventional-changelog-cli/README.md

@@ -108,16 +108,9 @@ message="chore(release): %s :tada:"
 - No or few task runner or build tool integrations.
 
 
-## Related
-
-- [conventional-changelog](https://github.com/ajoslin/conventional-changelog) - API of this module
-- [standard-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog) - Similar to this module but only with angular convention
-- [conventional-github-releaser](https://github.com/conventional-changelog/conventional-github-releaser) - Make a new GitHub release from git metadata
-- [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
-- [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using
-- [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
-- [angular-precommit](https://github.com/ajoslin/angular-precommit) - Pre commit with angular conventions
-- [commitlint](https://github.com/marionebl/commitlint) - Lint commit messages
+## API
+
+Please use [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) 
 
 
 ## License

packages/conventional-changelog/README.md

@@ -2,12 +2,11 @@
 
 > Generate a changelog from git metadata
 
-It's recommended to use high level [standard-version](https://github.com/conventional-changelog/standard-version).
-Alternatively, you are probably looking for the [cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) module.
-Or use one of the plugins if you are already using the tool:  [grunt](https://github.com/btford/grunt-conventional-changelog)/[gulp](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/gulp-conventional-changelog)/[atom](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-atom).
 
 ## Usage
 
+Only use this module to build your Node.js app. See [Get started](https://github.com/conventional-changelog/conventional-changelog#get-started) if you're an end-user.
+
 ```sh
 $ npm install --save conventional-changelog
 ```
@@ -55,17 +54,6 @@ A scoped preset package such as `@scope/conventional-changelog-custom-preset` ca
 ## [Notes for parent modules](https://github.com/conventional-changelog/conventional-changelog-core#notes-for-parent-modules)
 
 
-## Related
-
-- [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) - cli of this module
-- [standard-changelog](https://github.com/conventional-changelog/standard-changelog) - Similar to this module but only with angular convention
-- [conventional-github-releaser](https://github.com/conventional-changelog/conventional-github-releaser) - Make a new GitHub release from git metadata
-- [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
-- [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using
-- [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
-- [angular-precommit](https://github.com/ajoslin/angular-precommit) - Pre commit with angular conventions
-- [commitlint](https://github.com/marionebl/commitlint) - Lint commit messages
-
 ## License
 
 MIT

packages/standard-changelog/README.md

@@ -50,15 +50,6 @@ $ standard-changelog --help
 
 See the [conventional-changelog](https://github.com/ajoslin/conventional-changelog) docs with the angular preset.
 
-## Related
-
-- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) - Generate a changelog from git metadata
-- [conventional-github-releaser](https://github.com/conventional-changelog/conventional-github-releaser) - Make a new GitHub release from git metadata
-- [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
-- [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using
-- [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
-- [angular-precommit](https://github.com/ajoslin/angular-precommit) - Pre commit with angular conventions
-
 ## License
 
 MIT