A brief explanation of the project here. Keep it short, 3-5 sentences! If you want this handy, just fork it. Note that this template is written on Markdown (GitHub flavor). If you needed a quick refresher on Markdown, visit this great cheatsheet. Also, feel free to submit pull request if you want to suggest improvements.
- Do this
- Do that
- Etc.
This section is open for your creativity and needs. You could add things like,
- Examples
- API information (illustrated below as an example),
- Etc.
Note: This API documentation template is extracted from Udacity.
To simplify your development process, we've provided a backend server for you to develop against. The provided file BooksAPI.js contains the methods you will need to perform necessary operations on the backend:
Method Signature:
getAll();- Returns a Promise which resolves to a JSON object containing a collection of book objects.
- This collection represents the books currently in the bookshelves in your app.
If your project is open-source and you would like contributions, include this part. Usually, there is a separate .md file describing how to contribute. For a great example of contribute.md, check out ThoughtBot's contribution markdown doc here.
- Known Bugs
- Table of Contents
- Etc.
First, choose your license. If need be, check out this great resource to decide on your license. Once chosen, you can put here something like:
The contents of this repository are covered under the MIT License.