Skip to content

Commit

Permalink
📘 docs: update readme about postinstall
Browse files Browse the repository at this point in the history
  • Loading branch information
Rettend committed Jan 23, 2024
1 parent 72083b6 commit d7c7653
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ There are two different ways to install `eemoji`:

Thanks to the `postinstall` script, after installing `eemoji` locally/globally, it will automatically create the git hook for the current repo. This means it will just work, but it's especially useful when other users are going to contribute to your repository.

> [!TIP]
> If you use `yarn` or `pnpm`, which do not run `postinstall` scripts by default, you need to run `eemoji init` manually.
> Besides that, you can create a `prepare` script in your `package.json`, so that it will be run automatically for others who contribute to your repository:
>
> ```json
> {
> "scripts": {
> "prepare": "eemoji init -c none"
> }
> }
### Local
```bash
Expand Down
6 changes: 2 additions & 4 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@
- [ ] 2 more options: (any combination of these should work)
- [ ] `strict (boolean) [false]` - do not allow any commits without emojis
- [ ] `conventional (boolean) [true]` - only allow conventional commits, this package should work without conventional commits as well
- [ ] new option: `mode (overwrite|append) [append]` - overwrite or append the config (for both json and ts) (idea: if emoji prop is specified, overwrite, else use default + you can import the default emojis to append them)
- [ ] if emoji prop is specified, overwrite, else use default + you can import the default emojis to append them
- [x] add `-v` alias for `--version`
- [x] make the consola start and success logs sane in the cleanup command
- [ ] investigate speed, prepare script for init
- [ ] rewrite the bin files in typescript and also build them
- [ ] refactor a lot!
- [x] investigate speed, prepare script for init
- [ ] Generate the readme emoji table from `emojis.json` (jsonc for description)
- [ ] try astro and create a small website explaining which emoji to use and when, + stuff

0 comments on commit d7c7653

Please sign in to comment.