circleci - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

		{
		"name": "circleci",
		"version": "0.1.0",
		"version": "0.1.1",
		"description": "A Node.js client for CircleCI",
		@@ -17,3 +17,3 @@ "main": "dist/circleci.js",
		],
		"author": "Jack Stevens <jack.stevens@fundingcircle.com>",
		"author": "Jack Stevens <jack@applyr.com>",
		"license": "ISC",
		@@ -20,0 +20,0 @@ "repository": {

README.md

		@@ -96,2 +96,24 @@ # CircleCI

		### getBranchBuilds

		Recent builds for a single project filtered by a branch name. Returns the build summary for each of the last 30 builds for a single git repo.

		#### Example Usage

		```javascript
		ci.getBranchBuilds({ username: "jpstevens", project: "circleci", branch: "master" })
		.then(function(builds){
		for(var i=0; i < builds.length; i++) {
		console.log(builds[i].build_num); // logs the build number for each project
		}
		});
		```

		#### Options
		- username [required] - The username for the project you wish to look up
		- project [required] - The project (repo) name you wish to look up
		- branch [required] - The branch name you wish to use as filter
		- limit [optional] - The number of builds to return. Maximum 100, defaults to 30)
		- offset [optional] - The API returns builds starting from this offset, defaults to 0)

		### getBuild
		@@ -220,1 +242,8 @@
		- project [required] - The project (repo) name you wish to look up


		## Change Log

		0.1.0 - Initial (stable) release

		0.1.1 - Add `getBranchBuilds` method

New alerts