Browse files

Add documentation on programmatical usage.

  • Loading branch information...
1 parent 4d991ed commit c30d275d41456e122935b503c5d76176b5c46ba0 @cliffano committed Jan 23, 2013
Showing with 13 additions and 0 deletions.
  1. +1 −0 CHANGELOG.md
  2. +12 −0 README.md
View
1 CHANGELOG.md
@@ -1,5 +1,6 @@
### 0.1.1-pre
* Move status colouring to cli so that when lib/jenkins is used programatically then it gets plain uncoloured text
+* JENKINS_URL is now handled by lib/jenkins
### 0.1.0
* Move commands setup to conf/commands.json, cli handling to bag.cli.command
View
12 README.md
@@ -61,6 +61,18 @@ Start an IRC bot:
nestor irc <host> <channel> [nick]
+Programmatically:
+
+ var nestor = new (require('nestor'))(
+ 'http://user:pass@host:port/path'
+ );
+
+ // trigger a parameterised build
+ nestor.build('job', 'param1=value1&param2=value2', function (err, result) {
+ });
+
+Check out [lib/jenkins](https://github.com/cliffano/nestor/blob/master/lib/jenkins.js) for available methods.
+
Configuration
-------------

0 comments on commit c30d275

Please sign in to comment.