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

No README #21

Closed
paulo-ferraz-oliveira opened this issue May 17, 2022 · 3 comments · Fixed by #28
Closed

No README #21

paulo-ferraz-oliveira opened this issue May 17, 2022 · 3 comments · Fixed by #28
Labels
documentation Improvements or additions to documentation

Comments

@paulo-ferraz-oliveira
Copy link

Project has no README.

It's important (even if for first version) this is present, to help consumers.

@paulo-ferraz-oliveira
Copy link
Author

Stuff like:

  • short description of what this is for,
  • features
  • options
  • installation
  • examples
  • versioning
  • other standards
  • contributing
  • license
    are a nice starting place.

@kyuuzou kyuuzou pinned this issue May 18, 2022
@kyuuzou kyuuzou added the documentation Improvements or additions to documentation label May 18, 2022
@kyuuzou kyuuzou linked a pull request May 26, 2022 that will close this issue
@kyuuzou kyuuzou reopened this May 26, 2022
@kyuuzou
Copy link
Contributor

kyuuzou commented May 26, 2022

Still missing:

  • features
  • installation
  • examples
  • versioning
  • contributing

@paulo-ferraz-oliveira
Copy link
Author

There is a README in the project, these days. I'll close this issue. Thanks.

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
Development

Successfully merging a pull request may close this issue.

2 participants