Action plan - Project description, table of contents and how to use

[somecodingwitch]

Problem

Since the repository is public, it is obviously open to everyone that wants to play with it, contribute and even get code pieces and inspiration to build their own projects. I have explored a little of the project and it's a good place to find some thrown code with features that may be interesting for anyone, but that can only be achieved by reading the code and it is not a common thing to be done directly without a proper explanatory readme.

This repository can also be one great entry points to every person interested on understanding more about how Woovi stack is really works besides only talking about the implemented technologies and also help to build the challenges - like the relay workshop one.

Solution

Create a basic readme explaining about the project, what it is - a little description - and not only how to contribute/use the app. A good table of contents would be:

• Project description
  • Pre-requisites
  • Clear objective
  • Contained technologies
  • Contained features
• How to contribute
  • Roadmap(?)
  • Requirements
  • Creating an issue
  • Creating a pull request
  • Contact ways