Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
* Use "`README.md`" instead of "it" in installation instruction
* Replace usage instructions with a list.
* Add link for "open an issue" and "open a pull request"
  • Loading branch information
christianbundy committed Jul 8, 2014
1 parent c960f2b commit 97006ec
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A collection of best practices for a simple and informative README.

## Installation

Download to your project directory, add it, and commit.
Download to your project directory, add `README.md`, and commit:

```sh
curl -O https://github.com/christianbundy/readme-boilerplate.md
Expand All @@ -14,12 +14,21 @@ git commit -m "Add README Boilerplate"

## Usage

Edit `README.md` with the name of your project, a description, installation instructions, usage instructions, how to get support, and how people can contribute to your project.
Replace the contents of `README.md` with your project's:

* Name
* Description
* Installation instructions
* Usage instructions
* Support instructions
* Contributing instructions

Feel free to remove any sections that aren't applicable to your project.

## Support

Please open an issue to receive support for this project.
Please [open an issue](https://github.com/christianbundy/readme-boilerplate/issues/new) for questions and concerns.

## Contributing

Fork the project, create a new branch, make your changes, and open a pull request.
Fork the project, commit your changes, and [open a pull request](https://github.com/christianbundy/readme-boilerplate/compare/).

0 comments on commit 97006ec

Please sign in to comment.