From 51f2cb6a17beccaed9ed6d656451b37858bc37f2 Mon Sep 17 00:00:00 2001 From: KaKi87 Date: Sat, 6 Nov 2021 17:09:51 +0100 Subject: [PATCH] :memo: Add README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2b8b88 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# gitmoji-lite + +[![](https://shields.kaki87.net/website.svg?url=https://gitmoji.kaki87.net)](https://gitmoji.kaki87.net) + +An emoji guide for your commit messages. + +## Differences with the [original Gitmoji project by carloscuesta](https://github.com/carloscuesta/gitmoji) + +### Ad-free + +The original project's website contains ads since [PR #631](https://github.com/carloscuesta/gitmoji/pull/631). + +This project's website does not contain ads nor any other annoyance. + +### Framework-free + +The original project's website uses NextJS since [PR #368](https://github.com/carloscuesta/gitmoji/pull/368), and was using GulpJS before that since [commit `f2a567d`](https://github.com/carloscuesta/gitmoji/commit/f2a567de553f7f41e05dd7b3693d637387e7ce5d). + +This project's webiste does not use any framework but only pure HTML/CSS/JS. + +### Unofficial gitmojis + +The original project's maintainers sometimes reject gitmoji submissions, despite respecting the [contributing guidelines](https://github.com/carloscuesta/gitmoji/blob/master/.github/CONTRIBUTING.md#how-to-add-a-gitmoji), or let submissions unsolved forever, even after discussion and approval. + +This project's website uses the same gitmoji list as the original, but also adds the following rejected gitmojis, with an *unofficial* badge. + +- `:nerd_face:` `Improve developer experience` ([issue #214](https://github.com/carloscuesta/gitmoji/issues/214), unsolved) +- `:fast_forward:` `Redo changes` ([issue #169](https://github.com/carloscuesta/gitmoji/issues/169), rejected) + +Unofficial gitmoji submissions are welcome, provided that an existing submission has been rejected or left unsolved on +the official project's issue tracker, despite respecting the contributing guidelines. \ No newline at end of file