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

Complete README #12

Closed
5 of 6 tasks
Tracked by #16
lopezjuanma96 opened this issue Nov 11, 2022 · 1 comment
Closed
5 of 6 tasks
Tracked by #16

Complete README #12

lopezjuanma96 opened this issue Nov 11, 2022 · 1 comment

Comments

@lopezjuanma96
Copy link
Contributor

lopezjuanma96 commented Nov 11, 2022

Context

For releasing the repository publicly and allow other people to contribute to it's development and use the API as a service, we need a good documentation, including improving the README with usecases, rules, etc. For a proper doc follow

Causes/Justification

Giving potential users a brief description of what our Realiser is and how they can make use of it.
Describing the project to potential devs that want to contribute to it.
Provinding for both users and devs with a simple and direct way of proposing features and raising awareness about bugs.

Solution Alternatives

  • Summary - TL;DR
  • How Does it Work
  • Getting Started
  • Resource
  • Contributing
  • Acknowledgements

Repercussions

@lopezjuanma96
Copy link
Contributor Author

acknowledgements won't be added for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant