https://github.com/bitroniq/readme-template
This is a README.md template to use in projects.
https://github.com/bitroniq/readme-template
badges readme readme-bolierplate readme-template
Last synced: 3 months ago
JSON representation
This is a README.md template to use in projects.
- Host: GitHub
- URL: https://github.com/bitroniq/readme-template
- Owner: bitroniq
- License: mit
- Created: 2018-07-17T14:56:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-17T17:09:09.000Z (about 7 years ago)
- Last Synced: 2025-04-05T20:02:36.356Z (6 months ago)
- Topics: badges, readme, readme-bolierplate, readme-template
- Homepage:
- Size: 1.55 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Product Name
> Short text about your project and what it does.
[![LICENSE][license-image]][license-url]
[![Jekyll][jekyll-image]][jekyll-url]
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]
Short (up to two paragraphs) statement about your product:
* The purpose.
* What it does.
## Installation
OS X & Linux:
```sh
npm install my-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
> All notable changes to this project will be documented in this section.
> The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
> and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
> ### How do I make a good changelog?
> #### Guiding Principles
> * Changelogs are for humans, not machines.
> * There should be an entry for every single version.
> * The same types of changes should be grouped.
> * Versions and sections should be linkable.
> * The latest version comes first.
> * The release date of each version is displayed.
> * Mention whether you follow Semantic Versioning.
> #### Types of changes
> * `Added` for new features.
> * `Changed` for changes in existing functionality.
> * `Deprecated` for soon-to-be removed features.
> * `Removed` for now removed features.
> * `Fixed` for any bug fixes.
> * `Security` in case of vulnerabilities.
### [Unreleased]
### [v1.1] - 2018-07-17
#### Fixed
- Fixed some typos
#### Added
- This CHANGELOG file to hopefully serve as an evolving example of a
standardized open source project CHANGELOG.
### [v1.0] - 2018-07-17
#### Fixed
- Some typos
[Unreleased]: https://github.com/bitroniq/readme-template/compare/v1.1...HEAD
[v1.1]: https://github.com/bitroniq/readme-template/compare/v1.0...v1.1
[v1.0]: https://github.com/bitroniq/readme-template/compare/ff494e6...v1.0
---
## Meta
Your Name – [@YourTwitter](https://twitter.com/YourLoign) – YourEmail@example.com
Distributed under the XYZ license. See ``LICENSE`` for more information.
[https://github.com/yourname/github-link](https://github.com/yourname/github-link)
## 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
[license-image]: https://img.shields.io/badge/license-MIT-lightgrey.svg
[license-url]: https://raw.githubusercontent.com/bitroniq/bitroniq.github.io/master/LICENSE
[jekyll-image]: https://img.shields.io/badge/jekyll-%3E%3D%203.6-blue.svg
[jekyll-url]: https://jekyllrb.com/
[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/rust-lang/rust.svg?maxAge=2592000
[travis-url]: https://travis-ci.org/bitroniq/node-datadog-metrics
[wiki]: https://github.com/yourname/yourproject/wiki