Your project’s name is the first thing people will see upon scrolling down to your README, and is included upon creation of your README file.

A description of your project follows. A good description is clear, short, and to the point. Describe the importance of your project, and what it does.

Todo is a Restful webservice designed to assist users with building their own Todo application. This service will provide various methods and available calls to accommodate general uses of a Todo task list.

This project provides API endpoints to operate CRUD functionality to manage a personal To Do list:

• Add daily tasks with due date
• Add contact information and reminder for important phone calls
• Keep track of items you want to purchase
• Maintain a daily or weekly routine by recording your Todo session
• Make a list of groceries to help you save time at the store, save a list for next time

Optionally, include a table of contents in order to allow other people to quickly navigate especially long or detailed READMEs.

Installation is the next section in an effective README. Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.

The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.

• Add your IP Address to the Network Access
  • Log into account, click Network Access on left navigation
  • Click 'ADD IP ADDRESS'

• Add MongoDB password to the Environment variable
  • Use label 'MongoDB_Password'

Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for setting guidelines for repository contributors.

This has been initiaited by a group of 3 developers. Your feedback in appreciated and encourage in how to improve. This service is limited to the available endpoints that we were able to think of and build. We welcome ideas to provide more options and features.

Include a section for credits in order to highlight and link to the authors of your project.

Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!

Your README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis, outlined below.