Skip to content
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

Write proper README #4

Open
1 of 3 tasks
shawly opened this issue Sep 18, 2021 · 0 comments
Open
1 of 3 tasks

Write proper README #4

shawly opened this issue Sep 18, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@shawly
Copy link
Member

shawly commented Sep 18, 2021 •
edited
Loading

Since the module is pretty much stable now and technically usable for others, we should add a proper README to describe the usage of the module and add nice pictures.

  • add pictures of the project in use
  • write usage guide with screenshots for configuration
  • (optional) create a cool logo for the project? (maybe Cthulhu's head with keypads attached to the tentacles would look nice)
@shawly shawly added the documentation Improvements or additions to documentation label Sep 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@shawly