badges.md

   1 ---
   2 title: Code badges
   3 ---
   4
   5 Here are some badges for open source projects.
   6
   7 ### Badge markdown
   8
   9     Travis
  10     [![Status](https://travis-ci.org/rstacruz/REPO.svg?branch=master)](https://travis-ci.org/rstacruz/REPO)
  11     CodeClimate (shields.io)
  12     [![CodeClimate](http://img.shields.io/codeclimate/github/rstacruz/REPO.svg?style=flat)](https://codeclimate.com/github/rstacruz/REPO
  13     "CodeClimate")
  14
  15     Coveralls (shields.io)
  16     [![Coveralls](http://img.shields.io/coveralls/rstacruz/REPO.svg?style=flat)](https://coveralls.io/r/rstacruz/REPO)
  17
  18     Travis (shields.io)
  19     [![Status](http://img.shields.io/travis/rstacruz/REPO/master.svg?style=flat)](https://travis-ci.org/rstacruz/REPO "See test builds")
  20
  21     NPM (shields.io)
  22     [![npm version](http://img.shields.io/npm/v/REPO.svg?style=flat)](https://npmjs.org/package/REPO "View this project on npm")
  23
  24     Ruby gem (shields.io)
  25     [![Gem](https://img.shields.io/gem/v/GEMNAME.svg?style=flat)](http://rubygems.org/gems/GEMNAME "View this project in Rubygems")
  26
  27 ### Etc
  28
  29     Gitter chat
  30     [![Gitter chat](https://badges.gitter.im/USER/REPO.png)](https://gitter.im/REPO/GITTERROOM "Gitter chat")
  31
  32     Gitter chat (shields.io)
  33     [![Chat](http://img.shields.io/badge/gitter-USER / REPO-blue.svg)]( https://gitter.im/USER/REPO )
  34
  35     david-dm
  36     [![Dependencies](http://img.shields.io/david/rstacruz/REPO.svg?style=flat)](https://david-dm.org/rstacruz/REPO)
  37
  38     [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
  39
  40 ### Support stuff
  41
  42     Support
  43     -------
  44
  45     __Bugs and requests__: submit them through the project's issues tracker.<br>
  46     [![Issues](http://img.shields.io/github/issues/USER/REPO.svg)]( https://github.com/USER/REPO/issues )
  47
  48     __Questions__: ask them at StackOverflow with the tag *REPO*.<br>
  49     [![StackOverflow](http://img.shields.io/badge/stackoverflow-REPO-blue.svg)]( http://stackoverflow.com/questions/tagged/REPO )
  50
  51     __Chat__: join us at gitter.im.<br>
  52     [![Chat](http://img.shields.io/badge/gitter.im-USER/REPO-blue.svg)]( https://gitter.im/USER/REPO )
  53
  54 ### Frontend js installation
  55
  56     Installation
  57     ------------
  58
  59     Add [nprogress.js] and [nprogress.css] to your project.
  60
  61     ```html
  62     <script src='nprogress.js'></script>
  63     <link rel='stylesheet' href='nprogress.css'/>
  64     ```
  65
  66     NProgress is available via [bower] and [npm].
  67
  68         $ bower install --save nprogress
  69         $ npm install --save nprogress
  70
  71     [bower]: http://bower.io/search/?q=nprogress
  72     [npm]: https://www.npmjs.org/package/nprogress
  73
  74 ### Acknowledgements
  75
  76     **PROJECTNAME** © 2014+, Rico Sta. Cruz. Released under the [MIT] License.<br>
  77     Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).
  78
  79     > [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;
  80     > GitHub [@rstacruz](https://github.com/rstacruz) &nbsp;&middot;&nbsp;
  81     > Twitter [@rstacruz](https://twitter.com/rstacruz)
  82
  83     [MIT]: http://mit-license.org/
  84     [contributors]: http://github.com/rstacruz/nprogress/contributors
  85
  86 ### Links
  87
  88  * Everything: http://shields.io/
  89
  90  * Version badge (gems, npm): http://badge.fury.io/
  91
  92  * Dependencies (ruby): http://gemnasium.com/
  93
  94  * CI: http://travis-ci.org/
  95
  96  * Code quality (ruby): http://codeclimate.com/
  97
  98  * Test coverage: https://coveralls.io/
  99