Skip to content

Commit

Permalink
Added bower support and updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
bmpvieira committed Jan 24, 2014
1 parent e23f9c4 commit 9df26b6
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ Install bionode with [npm](https://npmjs.org/):
$ npm install bionode
```

You can also install it for client side with [bower](http://bower.io)

```sh
$ bower install bionode
```

Alternatively, just include `bionode.min.js` via a `<script/>` in your page.


Expand All @@ -25,7 +31,7 @@ var bionode = require('bionode')

In-browser, `bionode` is available as a global variable.

Please check the [documentation](https://rawgithub.com/bionode/bionode/master/docs/bionode.html) for the methods exposed by bionode.
Please read the [documentation](https://rawgithub.com/bionode/bionode/master/docs/bionode.html) for the methods exposed by bionode.


Contributing
Expand All @@ -39,17 +45,20 @@ Please write unit tests for your code, and check that everything works by runnin
$ npm test
```

Also check for code coverage:
Please also check for code coverage:

```sh
$ npm run coverage
```

To rebuild and minify the module for the browser do:
To rebuild and minify the module for the browser:

```sh
$ npm run build-browser
```

To rebuild the documentation from the comments in the code, run:
To rebuild the documentation using the comments in the code:

```sh
$ npm run build-docs
```
Expand Down
26 changes: 26 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"name": "bionode",
"description": "A Node.js JavaScript library for client and server side bioinformatics.",
"version": "0.0.3",
"homepage": "bionode.io",
"repository": { "type": "git", "url": "git://github.com/bionode/bionode.git" },
"authors": [ "Bruno Vieira <mail@bmpvieira.com> (http://bmpvieira.com)" ],
"license": "MIT",
"main": "bionode.min.js",
"keywords": [
"bioinformatics",
"genomics",
"genetics",
"dna",
"util",
"server",
"client",
"browser"
],
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test"
]
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bionode",
"description": "A Node.js JavaScript library for client and server side bioinformatics",
"version": "0.0.2",
"version": "0.0.3",
"homepage": "http://bionode.io",
"repository": "git://github.com/bionode/bionode.git",
"author": {
Expand Down

0 comments on commit 9df26b6

Please sign in to comment.