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.

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

Improve README file #7

Open
5 of 6 tasks
StefanGreve opened this issue Apr 17, 2022 · 1 comment
Open
5 of 6 tasks

Improve README file #7

StefanGreve opened this issue Apr 17, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@StefanGreve
Copy link
Owner

StefanGreve commented Apr 17, 2022

Make it more accessible to beginners and find good use-cases/examples for demonstration purposes.

  • improve description
  • add more hands-on examples
  • outline technical limitations
  • create a project logo
  • add a list of contributors table
  • make a list of all available functions
@StefanGreve StefanGreve self-assigned this Apr 17, 2022
@StefanGreve StefanGreve added the documentation Improvements or additions to documentation label Apr 17, 2022
@StefanGreve StefanGreve mentioned this issue Jan 2, 2023
22 tasks
@StefanGreve StefanGreve changed the title Rewrite the README Improve README file Jan 8, 2023
@StefanGreve StefanGreve added this to the Version 1.0.0 milestone Jan 19, 2023
@StefanGreve
Copy link
Owner Author

Subtask: issue #12

@StefanGreve StefanGreve added help wanted Extra attention is needed good first issue Good for newcomers labels Jan 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant