Skip to content

Commit

Permalink
πŸ“™ docs: update readme with presets
Browse files Browse the repository at this point in the history
  • Loading branch information
Rettend committed Jan 25, 2024
1 parent 778f37e commit e89f55d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ This way your emojis will be merged with the default ones.

Use the `init` command and select the `ts` config type.

- `defineDefaultConfig`: use this to append your emojis to the default ones
- `defineConfig`: use this to define your own config, without the default emojis

`eemoji` will look for these config files:

- `eemoji.config.ts`
Expand Down Expand Up @@ -294,6 +297,27 @@ Commit message:
- before: `chore(deps): update eslint`
- after: `πŸ“¦ chore(deps): update eslint`

### Presets

You can use presets, which are just functions with emoji objects that are included in the package.

> [!NOTE]
> The `emojis` property can be an array of presets and objects
```ts
import { defineConfig, presetDefault } from 'eemoji'

export default defineConfig({
emojis: [
presetDefault(),
{
feat: '✨',
fix: 'πŸ”§'
}
]
})
```

### JSON Config

Same deal, but you overwrite the whole config.
Expand Down

0 comments on commit e89f55d

Please sign in to comment.