diff --git a/README.md b/README.md index 1cec17b..2cd9db1 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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/).