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

Add documentation #1

Open
3 of 6 tasks
pergerch opened this issue Nov 2, 2018 · 0 comments
Open
3 of 6 tasks

Add documentation #1

pergerch opened this issue Nov 2, 2018 · 0 comments
Labels
documentation Documentation, help, userguides help wanted Extra attention is needed

Comments

@pergerch
Copy link
Member

pergerch commented Nov 2, 2018 •
edited

Improve README.md with

  • Basic functionality
  • Default settings
  • Configuration options
  • More examples
  • Enum update (adding, removing, renaming) issues
  • Contribution guidelines
@pergerch pergerch added help wanted Extra attention is needed documentation Documentation, help, userguides labels Nov 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation, help, userguides help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pergerch