-
-
Notifications
You must be signed in to change notification settings - Fork 805
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π Add readme file for
gitmojis
package
- Loading branch information
1 parent
73818b0
commit e7eca72
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<p align="center"> | ||
<a href="https://gitmoji.dev"> | ||
<img src="https://cloud.githubusercontent.com/assets/7629661/20073135/4e3db2c2-a52b-11e6-85e1-661a8212045a.gif" width="456" alt="gitmoji"> | ||
</a> | ||
</p> | ||
<p align="center"> | ||
<a href="https://github.com/carloscuesta/gitmoji/actions?query=workflow%3ACI+branch%3Amaster"> | ||
<img src="https://img.shields.io/github/actions/workflow/status/carloscuesta/gitmoji/ci.yml?branch=master&style=flat-square" | ||
alt="Build Status"> | ||
</a> | ||
<a href="https://gitmoji.dev"> | ||
<img src="https://img.shields.io/badge/gitmoji-%20π%20π-FFDD67.svg?style=flat-square" | ||
alt="Gitmoji"> | ||
</a> | ||
</p> | ||
|
||
## About | ||
|
||
The emojis from the [gitmoji](https://gitmoji.dev) convention **bundled** into a **node module**. | ||
|
||
## Install | ||
|
||
```bash | ||
npm i gitmojis | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
import { gitmojis } from 'gitmojis' | ||
|
||
console.log(gitmojis) | ||
|
||
/* | ||
[ | ||
{ | ||
emoji: 'π¨', | ||
entity: '🎨', | ||
code: ':art:', | ||
description: 'Improve structure / format of the code.', | ||
name: 'art', | ||
semver: null | ||
}, | ||
{ | ||
emoji: 'β‘οΈ', | ||
entity: '⚡', | ||
code: ':zap:', | ||
description: 'Improve performance.', | ||
name: 'zap', | ||
semver: null | ||
}, | ||
... | ||
] | ||
*/ | ||
``` | ||
|
||
## API | ||
|
||
Alternatively you can also consume this as through HTTP using the API: | ||
|
||
```bash | ||
curl https://gitmoji.dev/api/gitmojis | ||
``` | ||
|
||
## Spread the word | ||
|
||
Are you using Gitmoji on your project? Set the Gitmoji badge on top of your readme using this code: | ||
|
||
```html | ||
<a href="https://gitmoji.dev"> | ||
<img | ||
src="https://img.shields.io/badge/gitmoji-%20π%20π-FFDD67.svg?style=flat-square" | ||
alt="Gitmoji" | ||
/> | ||
</a> | ||
``` |