Back to Gitmoji

README

packages/gitmojis/README.md

3.15.01.6 KB
Original Source
<p align="center"> <a href="https://gitmoji.dev">
</a>
</p> <p align="center"> <a href="https://github.com/carloscuesta/gitmoji/actions?query=workflow%3ACI+branch%3Amaster">
</a>
<a href="https://gitmoji.dev">
	
</a>
</p>

About

The emojis from the gitmoji convention bundled into a node module.

Install

bash
npm i gitmojis

Usage

js
import { gitmojis } from 'gitmojis'

console.log(gitmojis)

/*
[
  {
    emoji: '🎨',
    entity: '&#x1f3a8;',
    code: ':art:',
    description: 'Improve structure / format of the code.',
    name: 'art',
    semver: null
  },
  {
    emoji: '⚡️',
    entity: '&#x26a1;',
    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">
  
</a>