docs(all): update README with latest PRs + add CHANGELOG

plouc · Mar 20, 2016 · 1b2e8c7 · 1b2e8c7
1 parent e030cd9
commit 1b2e8c7
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 12 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,7 @@ language: node_js
 node_js:
   - '0.12'
   - '4'
+  - '5'
 script:
   - npm run eslint
   - npm test
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# 1.1.0 (2016-03-20)
+
+### Features
+
+* **client:** add support for custom CA ([#11](https://github.com/plouc/mozaik-ext-jenkins/pull/11))
+* **job_status:** add support for `bold` layout for `JobStatus` component ([#5](https://github.com/plouc/mozaik-ext-jenkins/pull/5))
diff --git a/README.md b/README.md
@@ -1,19 +1,22 @@
 # Mozaïk jenkins widgets
 
-[![Travis CI](https://img.shields.io/travis/plouc/mozaik-ext-jenkins.svg?style=flat-square)](https://travis-ci.org/plouc/mozaik-ext-jenkins)
+[![Travis CI][travis-image]][travis-url]
+[![NPM version][npm-image]][npm-url]
+[![Dependencies][gemnasium-image]][gemnasium-url]
+![widget count][widget-count-image]
 
 ## Jenkins Client Configuration
 
 In order to use the Mozaïk jenkins widgets, you must configure its **client**.
 
 ### parameters
 
-key                 | env key                         | required | description
---------------------|---------------------------------|----------|-----------------------------------
-`baseUrl`           | JENKINS_API_BASE_URL            | yes      | *jenkins base url*
-`basicAuthUser`     | JENKINS_API_BASIC_AUTH_USER     | yes      | *jenkins auth user*
-`basicAuthPassword` | JENKINS_API_BASIC_AUTH_PASSWORD | yes      | *jenkins auth password*
-`customCa`          | JENKINS_API_CUSTOM_CA           | no       | *jenkins certificate*
+key                 | env key                         | required | description             | notes
+--------------------|---------------------------------|----------|-------------------------|-----------------------------------------------
+`baseUrl`           | JENKINS_API_BASE_URL            | yes      | *jenkins base url*      |
+`basicAuthUser`     | JENKINS_API_BASIC_AUTH_USER     | yes      | *jenkins auth user*     |
+`basicAuthPassword` | JENKINS_API_BASIC_AUTH_PASSWORD | yes      | *jenkins auth password* |
+`customCa`          | JENKINS_API_CUSTOM_CA           | no       | *jenkins certificate*   | require `mozaik-ext-jenkins >= 1.1.0`
 
 ### usage
 
@@ -88,10 +91,10 @@ key   | required | description
 
 ### parameters
 
-key      | required |description
----------|----------|---------------
-`job`    | yes      | *jenkins job identifier*
-`layout` | no       | *widget layout* (none for default or 'bold')
+key      | required |description                                   | notes
+---------|----------|----------------------------------------------|-----------------------------------------
+`job`    | yes      | *jenkins job identifier*                     |
+`layout` | no       | *widget layout* (none for default or 'bold') | require `mozaik-ext-jenkins >= 1.1.0`
 
 ### usage
 
@@ -125,3 +128,11 @@ key     | required | description
     columns: 2, rows: 1, x: 0, y: 0
 }
 ```
+
+[travis-image]: https://img.shields.io/travis/plouc/mozaik-ext-jenkins.svg?style=flat-square
+[travis-url]: https://travis-ci.org/plouc/mozaik-ext-jenkins
+[npm-image]: https://img.shields.io/npm/v/mozaik-ext-jenkins.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/mozaik-ext-jenkins
+[gemnasium-image]: https://img.shields.io/gemnasium/plouc/mozaik-ext-jenkins.svg?style=flat-square
+[gemnasium-url]: https://gemnasium.com/plouc/mozaik-ext-jenkins
+[widget-count-image]: https://img.shields.io/badge/widgets-x4-green.svg?style=flat-square
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mozaik-ext-jenkins",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Mozaik jenkins widgets",
   "repository": {
     "type": "git",
@@ -17,6 +17,7 @@
   },
   "keywords": [
     "jenkins",
+    "ci",
     "mozaik",
     "widget",
     "extension",