Brief explanation of the project.

• Installation
  • Basic Usage Install
  • Production Deployment
  • Development Install
• Usage / API
• Troubleshooting
• FAQs
• Team
• Contact
• Additional Resources
  • Project Changelog
  • Contributing Guide
  • Code of Conduct
  • Project License

Installation details should include local installation steps, and steps to deploy for end users (if applicable)

This is what the average visitor would need to do to install your application.

This is what a project implementor or partner (read: devops) would need to do to deploy your application in production (if applicable).

This is what a project contributor would need to do to install your application locally.

This should outline the basic and advanced usage of your application, and a complete API reference (if applicable)

This section is a work in progress. Troubleshooting issues and solutions will be posted here as they are raised.

This section is a work in progress. FAQs will be posted here as they are raised.

List of core team members here (optional)

The main method to contact the project lead, whether by email, Slack, IRC, carrier pidgeon or smoke signal.

Feel free to chat with the PROJECT core team (and many other users) on IRC in the #project channel on Freenode, or via email on the Project mailing list.

• Project Changelog
• Contributing Guide
• Code of Conduct
• Project License