A template for a readme of an open source project.

README.md

README.md

Title

Description

Screenshots with captions

Code Style

Getting Started

Prerequisites

• Python
• Postgres

Set up local development environment

Testing

API Reference

Quick start

• Base URL
• Authentication

Error Handling

• Response layout
• Overview of error codes

API Endpoints

<method> /<endpoint>, e.g.: GET /books

• General
  • Action: Creates/Updates/Deletes using JSON/Form encoded request data
  • Includes arguments/json/...
  • Returns: x, y, z
  • Pagination:
• Example Request
• Sample Response

...

• General
• Example Request
• Sample Response

Deployment

Authors

Acknowledgments