Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sixertoy committed Feb 14, 2020
1 parent b368b18 commit 89bd0ca
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 30 deletions.
46 changes: 23 additions & 23 deletions GITMOJO.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
| Keyword | Tag | Symbol | Alias |
| ------------- | ---------------------- | ------ | ------------------- |
| deploy | rocket | 🚀 | |
| init | tada | 🎉 | |
| tests | robot | 🤖 | test,robot |
| wip | construction | 🚧 | |
| revert | rewind | | |
| docker | whale | 🐳 | |
| bug | bug | 🐛 | bugs |
| refactor | truck | 🚚 | rfct,rfact,refacto |
| build | hammer | 🔨 | |
| config | gear | | conf |
| documentation | books | 📚 | docs,doc |
| auth | key | 🔑 | login |
| search | mag_right | 🔎 | |
| feature | sparkles | | feat,feats,features |
| style | art | 🎨 | css,sass,styles,ui |
| move | truck | 🚚 | |
| package | package | 📦 | dep,pkg |
| hotfix | rotating_light | 🚨 | fix |
| ci | vertical_traffic_light | 🚦 | |
| responsive | phone | ☎️ | mobile,phone |
| delete | boom | 💥 | rm,trash,cleanup |
| Keyword | Symbol | Alias |
| ------------- | ------ | ------------------- |
| deploy | 🚀 | |
| init | 🎉 | |
| tests | 🤖 | test,robot |
| wip | 🚧 | |
| revert | | |
| docker | 🐳 | |
| bug | 🐛 | bugs |
| refactor | 🚚 | rfct,rfact,refacto |
| build | 🔨 | |
| config || conf |
| documentation | 📚 | docs,doc |
| auth | 🔑 | login |
| search | 🔎 | |
| feature | | feat,feats,features |
| style | 🎨 | css,sass,styles,ui |
| move | 🚚 | |
| package | 📦 | dep,pkg |
| hotfix | 🚨 | fix |
| ci | 🚦 | |
| responsive | ☎️ | mobile,phone |
| delete | 💥 | rm,trash,cleanup |
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

[![NPM version][npm-version-img]][npm-url]

**Replace tags into your commit messages by emoji symbols**
**Emojilify all the things \o/**

## Requirements

- NodeJS v12.13.1
- [Husky v4.2.3](https://www.npmjs.com/package/husky)
- NodeJS >= 12.13.1
- [Husky >= 4.2.3](https://www.npmjs.com/package/husky)

## Install

Gitmojo need to be installed globally
GitMojo need to be installed globally

```bash
yarn global add gitmojo
# or npm install gitmojo -g
```

## Initialize Gitmojo in your project
#### Initialize GitMojo in your project

```bash
cd my-project
Expand All @@ -27,7 +27,7 @@ gitmojo init

Edit `.gitmojorc.json` to fit your needs

## Husky's hook configuration
#### Husky's hook configuration

Update `Husky's` configuration with `prepare-commit-msg` hook

Expand All @@ -41,7 +41,7 @@ Update `Husky's` configuration with `prepare-commit-msg` hook
}
```

## Defaults emojis
## Defaults Emojis

See [GITMOJO.md](./GITMOJO.md)

Expand Down

0 comments on commit 89bd0ca

Please sign in to comment.