https://github.com/dbader/readme-template
README.md template for your open-source project
https://github.com/dbader/readme-template
Last synced: 11 months ago
JSON representation
README.md template for your open-source project
- Host: GitHub
- URL: https://github.com/dbader/readme-template
- Owner: dbader
- Created: 2016-02-17T08:39:24.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T09:30:20.000Z (almost 3 years ago)
- Last Synced: 2025-04-01T17:11:08.141Z (11 months ago)
- Homepage: https://dbader.org/blog/write-a-great-readme-for-your-github-project
- Size: 26.4 KB
- Stars: 1,952
- Watchers: 33
- Forks: 4,148
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-github-readme-tools - README Template Generator - Simple README template for open source projects (Templates / JetBrains)
- starred-awesome - readme-template - README.md template for your open-source project (Others)
- awesome-list - readme-template - source project | dbader | 1637 | (Others)
README
# Product Name
> Short blurb about what your product does.
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]
One to two paragraph statement about your product and what it does.
## Installation
OS X & Linux:
```sh
npm install my-crazy-module --save
```
Windows:
```sh
edit autoexec.bat
```
## Usage example
A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
_For more examples and usage, please refer to the [Wiki][wiki]._
## Development setup
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
```sh
make install
npm test
```
## Release History
* 0.2.1
* CHANGE: Update docs (module code remains unchanged)
* 0.2.0
* CHANGE: Remove `setDefaultXYZ()`
* ADD: Add `init()`
* 0.1.1
* FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
* 0.1.0
* The first proper release
* CHANGE: Rename `foo()` to `bar()`
* 0.0.1
* Work in progress
## Meta
Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com
Distributed under the XYZ license. See ``LICENSE`` for more information.
[https://github.com/yourname/github-link](https://github.com/dbader/)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[npm-url]: https://npmjs.org/package/datadog-metrics
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
[wiki]: https://github.com/yourname/yourproject/wiki