Skip to content
Documentation templates for use in open source and open development projects
Branch: master
Clone or download
Pull request Compare This branch is even with adobe:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
CODE_OF_CONDUCT-Magento.md
CODE_OF_CONDUCT.md
COPYING.txt
COPYRIGHT
LICENSE
LICENSE-MIT
LICENSE-OSL
LICENSE_HEADER.md
README.md

README.md

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.

Non-Goals

It is also a good idea to declare what are not goals of the project to prevent potential feature creep.

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.

You can’t perform that action at this time.