Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sacdallago committed Feb 11, 2017
1 parent b92d079 commit 2e3aa74
Showing 1 changed file with 6 additions and 23 deletions.
29 changes: 6 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,23 @@
# mecu-viz
# mecu-line

[![NPM version](http://img.shields.io/npm/v/mecu-viz.svg)](https://www.npmjs.org/package/mecu-viz)
[![NPM version](http://img.shields.io/npm/v/mecu-graph.svg)](https://www.npmjs.org/package/mecu-graph)

> Visualization of protein melting curves
Visualization of protein melting curves

## Getting Started
Install the module with: `npm install mecu-viz`

```javascript
var viz = require('mecu-viz');
viz.hello("biojs"); // "hello biojs"
```
Install the module with: `npm install [email protected]:tpca/mecu-graph.git`

## Documentation

#### .hello(name)

**Parameter**: `name`
**Type**: `String`
**Example**: `biojs`

The 'hello' method is responsible for showing a name.

How to use this method

```javascript
viz.hello('biojs'); // "hello biojs"
```
Refer to the `/docs` folder

## Contributing

All contributions are welcome.

## Support

If you have any problem or suggestion please open an issue [here](https://github.com/sacdallago/mecu-viz/issues).
If you have any problem or suggestion please open an issue [here](https://github.com/tpca/mecu-graph/issues).

## License
This software is licensed under the Apache 2 license, quoted below.
Expand Down

0 comments on commit 2e3aa74

Please sign in to comment.