New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in 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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment