DOCS: Make a README.md and Update Wiki

[ohbus]

Please make an awesome README.md file

This is a Collated issue, this can be broken down into multiple small issues, the respective issue links for different tasks will be appended after the checklist.

This issue can be taken up by multiple assignees.

Take a Look at our Wiki section for inspiration Most of the README sections will be referring to the Wiki section already

Goals

• [ ] Provides a good overview of the project
• [ ] Links to Wiki on how to get engaged
• [ ] Improve Wiki section respectively for the necessary

Checklist for Wiki and README sections

• [x] Project Title
• [x] Dependencies / Technolgy Selection
• [ ] Installation
• [ ] Lombok Configuration
• [ ] Project Configuration
• [ ] Coding conventions
• [ ] Milestones & versioning
• [ ] API Endpoints Detailed Documentation with Response and Request bodies
• [ ] How to TEST the API endpoints
• [x] Collaboration
• [ ] Working with issues
• [ ] Reviewing pull requests
• [x] Static analysis
• [ ] IDE instructions
• [ ] Roadmap
• [x] Team
• [ ] Known issues
• [x] Getting help
• [x] Getting involved
• [ ] Recognizing contributors (Planning on using allcontributors)

Feel free to add your own points and let us know that you have completed any task on the Wiki, after reviewing we will update the same for you.

[championswimmer]

@ohbus let's add a README.md too, which has links to the discussion and to the wiki pages

People start from the README, go into Wiki for deeper details only.

[ohbus]

@ohbus let's add a README.md too, which has links to the discussion and to the wiki pages

People start from the README, go into Wiki for deeper details only.

Working on it!