Skip to content

Commit

Permalink
chore(project): update README, version, and dep versions
Browse files Browse the repository at this point in the history
  • Loading branch information
mbroadst committed Aug 17, 2015
1 parent e819b05 commit 220294a
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 33 deletions.
10 changes: 8 additions & 2 deletions AUTHORS
@@ -1,10 +1,16 @@
208 Camilo Aguilar
217 Camilo Aguilar
57 Matt Broadstone
33 Anthony Hinsinger
8 Subho Banerjee
7 Daniel Moser Tralamazza
6 Kenneth Stanley
4 Daniel Tralamazza
2 Anthony Hinsinger
4 Joe Pettit
2 Michael Maier
2 Zack Buhman
1 Damian Kaczmarek
1 Jasper Lievisse Adriaanse
1 The Gitter Badger
1 Wout Mertens
1 bountysource-support
1 camilo
27 changes: 11 additions & 16 deletions README.md
@@ -1,6 +1,11 @@
# Node-libvirt - The virtualization API bindings for [NodeJS][nodejs_home]
node-libvirt - The virtualization API bindings for [NodeJS][nodejs_home]
=============

[![Build Status](https://secure.travis-ci.org/hooklift/node-libvirt.svg?branch=master)](https://travis-ci.org/hooklift/node-libvirt)
[![Dependency Status](https://david-dm.org/hooklift/node-libvirt.svg)](https://david-dm.org/hooklift/node-libvirt)
[![npm version](https://badge.fury.io/js/libvirt.svg)](http://badge.fury.io/js/libvirt)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/hooklift/node-libvirt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
</a> [![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=339079)](https://www.bountysource.com/trackers/339079-node-libvirt?utm_source=339079&utm_medium=shield&utm_campaign=TRACKER_BADGE)
[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=339079)](https://www.bountysource.com/trackers/339079-node-libvirt?utm_source=339079&utm_medium=shield&utm_campaign=TRACKER_BADGE)

Libvirt is a toolkit to interact with virtualization capabilities
of recent versions of GNU/Linux (and other OSes). (reference: [Libvirt][libvirt_home])
Expand Down Expand Up @@ -33,24 +38,14 @@ Node-Libvirt is a set of bindings to Libvirt API, which allows to use it from Ja
You must have [NodeJS][nodejs_dev] and [Libvirt][libvirt_dev] already installed to be able to build node-libvirt.

### Get and Install node-libvirt
$ git clone git://github.com/c4milo/node-libvirt.git
$ sudo apt-get install libvirt-dev
$ git clone git://github.com/hooklift/node-libvirt.git
$ cd node-libvirt
$ node-gyp configure
$ node-gyp build

### Use node-libvirt in your project
From `node-libvirt`'s folder:

$ npm link

From your app's folder:

$ npm link libvirt

$ npm install OR ( node-gyp configure && node-gyp build )

## Example of use
For now please take a look at the tests.

## API
Work in progress at [docs page][docs_link]

Expand Down
58 changes: 44 additions & 14 deletions package.json
@@ -1,33 +1,63 @@
{
"name": "libvirt",
"version": "0.1.3",
"author": "Camilo Aguilar - http://github.com/c4milo",
"email": "camilo@cloudescape.com",
"version": "1.0.0",
"author": {
"name": "Camilo Aguilar",
"email": "camilo@cloudescape.com",
"url": "http://github.com/c4milo"
},
"contributors": [
"Subho Banerjee - subs.zero [AT] gmail [DOT] com",
"Daniel Tralamazza - daniel.tralamazza [AT] epfl [DOT] ch",
"Wout Mertens - @wmertens",
"Michael Maier - https://github.com/binBASH"
{
"name": "Matt Broadstone",
"email": "mbroadst@gmail.com"
},
{
"name": "Subho Banerjee",
"email": "subs.zero [AT] gmail [DOT] com"
},
{
"name": "Daniel Tralamazza",
"email": "daniel.tralamazza [AT] epfl [DOT] ch"
},
{
"name": "Wout Mertens"
},
{
"name": "Michael Maier",
"url": "https://github.com/binBASH"
}
],
"description": "libvirt bindings for v8 javascript engine",
"description": "Native libvirt C++ bindings for node.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "http://github.com/c4milo/node-libvirt.git"
"url": "http://github.com/hooklift/node-libvirt.git"
},
"main": "lib/index.js",
"engines": {
"node": ">=0.10.0"
},
"keywords": [
"libvirt",
"virt",
"virtualization",
"kvm",
"qemu",
"cloud",
"openstack",
"vm",
"virtualmachine"
],
"dependencies": {
"nan": "^1.7.0",
"bindings": "^1.2.1",
"bluebird": "^2.9.24"
"bluebird": "^2.9.34",
"nan": "^1.9.0"
},
"devDependencies": {
"mocha": "^2.2.1",
"chai": "^2.2.0",
"chai": "^3.2.0",
"jshint": "^2.8.0",
"mocha": "^2.2.5",
"segfault-handler": "^0.2.4",
"jshint": "^2.6.0",
"semver": "^5.0.1"
}
}
6 changes: 5 additions & 1 deletion test/domain.test.js
Expand Up @@ -480,10 +480,14 @@ describe('Domain', function() {
});

it('should return the domain information', function(done) {
// @todo: these should be better defined somewhere
// var runningState = test.domain.VIR_DOMAIN_RUNNING;
var runningState = 1;

test.domain.getInfo(function(err, info) {
expect(err).to.not.exist;
expect(info).to.include({
state: test.domain.VIR_DOMAIN_RUNNING,
state: runningState,
maxMemory: 8388608,
memory: 2097152,
vcpus: 2
Expand Down

0 comments on commit 220294a

Please sign in to comment.