New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Improve the readme #4

Open

1 of 4 tasks

gustavwilliam opened this issue Nov 22, 2021 · 0 comments

Labels

documentation enhancement

Owner

gustavwilliam commented Nov 22, 2021 •

edited

Loading

Right now, the README.md is horrible. It doesn't convey any information about the project at all.

Let's fix that.

What to add

The readme should include the following:

A introduction to/showcase of the project
Dev/setup instructions
Contributor guidelines
License (including a mention of the Twemoji license)

gustavwilliam added documentation enhancement labels

# for free to join this conversation on GitHub. Already have an account? # to comment