Open Source Starter Repo
This repository contains templates for project documentation, ensuring necessary
legal and contributor documentation is explicit. All sections below in this README.md
should be considered a template for a typical project README.md
.
PROJECT NAME
A short description of what this project does.
Goals
It is a good idea to provide a mission statement for your project, enshrining what the project wants to accomplish so that as more people join your project everyone can work in alignment.
Installation
Instructions for how to download/install the code onto your machine.
Example:
npm install myProject --save
Usage
Usage instructions for your code.
Example:
var myMod = require('mymodule');
myMod.foo('hi');
Contributing
Contributions are welcomed! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.