An open API service indexing awesome lists of open source software.

https://github.com/node-ci/nci-shields

Pretty svg status shields plugin for nci https://github.com/node-ci/nci
https://github.com/node-ci/nci-shields

Last synced: 6 months ago
JSON representation

Pretty svg status shields plugin for nci https://github.com/node-ci/nci

Awesome Lists containing this project

README

          

# nci-shields
[![Build Status](https://travis-ci.org/node-ci/nci-shields.svg?branch=master)](https://travis-ci.org/node-ci/nci-shields)

Pretty svg status shields plugin for [nci](https://github.com/node-ci/nci)

## Dependencies

[nci-express](https://github.com/node-ci/nci-express)

## Installation

```sh
npm install nci-shields
```

## Usage

Add this plugin to the `plugins` section at server config
```yml
plugins:
#express plugin should be included before shields plugin
- nci-express
- nci-shields
```
after that you can get status shields:

* `http://localhost:3000/shields/:projectName.svg` for project
* `http://localhost:3000/shields/builds/:id.svg` for build
* `http://localhost:3000/shields/:projectName/revs/:rev.svg` for project revision
(any scm revision, tag, branch that was selected as target for the build)

## Legal

Shields generated with [shields.io](http://shields.io/)

## License

[The MIT License](https://raw.githubusercontent.com/node-ci/nci-shields/master/LICENSE)