Skip to content

Commit

Permalink
💄 Update the documentation (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmembre-zenika authored and frinyvonnick committed Oct 3, 2018
1 parent 9561914 commit 2ae9819
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions README.md
Expand Up @@ -12,9 +12,12 @@ This library generates changelog for repositories using [gitmoji](https://gitmoj

**Workflow:**
1. Make changes and commit
```
git commit . -m ":sparkles: my awesome feature"
```
2. Bump version in package.json
3. `gitmoji-changelog`
4. Commit package.json and changelog files
3. Run `gitmoji-changelog`, the file `changelog.md` is created or updated with the summary of all changes in the release. See the example below.
4. Commit `package.json` and `changelog` files
5. Tag and push

### CLI
Expand All @@ -27,6 +30,37 @@ gitmoji-changelog

**// TODO**

## Setup

Install the lib in your PATH :

```bash
npm install -g gitmoji-changelog
```

## Mapping

When a commit is done with a gitmoji, the following mapping is used to group them :

| Categorie | Gitmoji |
|---|---|
| Added | :sparkles: :tada: :white_check_mark: :bookmark: :construction_worker: :chart_with_upwards_trend: :heavy_plus_sign: :loud_sound: |
| Changed | :art: :zap: :lipstick: :rotating_light: :arrow_down: :arrow_up: :pushpin: :recycle: :wrench: :rewind: :alien: :truck: :boom: :bento: :wheelchair: :speech_balloon: :card_file_box: :children_crossing: :building_construction: :iphone: |
| Removed | :fire: :heavy_minus_sign: :mute: |
| Fixed | :bug: :ambulance: :apple: :penguin: :checkered_flag: :robot: :green_apple: :green_heart: :pencil2: |
| Security | :lock: |


> See [mapping.js](packages/gitmoji-changelog-core/src/mapping.js) for more details

## Example

Here is an example of the produced `changelog.md` produced :

![Changelog example](doc/screenshot.png)


## Roadmap

### MVP
Expand Down
Binary file added doc/screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2ae9819

Please sign in to comment.