Skip to content

Commit

Permalink
Merge pull request #2 from hybridgroup/import-readme
Browse files Browse the repository at this point in the history
Update readme for import script
  • Loading branch information
deadprogram committed Dec 26, 2014
2 parents c75b80d + ad86e87 commit b861647
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.markdown → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ This repository contains the Cylon adaptor for the MiP robot from Wowwee (http:/
For more information about Cylon, check out the repo at
https://github.com/hybridgroup/cylon

## Getting Started
## How to Install

Install the module with: `npm install cylon-mip`
$ npm install cylon-mip

## Example
## How to Use

```javascript
var Cylon = require('cylon');
Expand All @@ -30,14 +30,21 @@ Cylon.robot({
});
}
}).start();

```

## Connecting
## How to Connect

You need to determine the `uuid` of your MiP. One way to do this, is to use the `cylon-ble-scan` command line utility installed as part of [cylon-ble](https://github.com/hybridgroup/cylon-ble).

Once you know your `uuid` just substititute it into your code.

## Documentation

We're busy adding documentation to [cylonjs.com](http://cylonjs.com). Please check there as we continue to work on Cylon.js.

Thank you!

## Contributing

* All patches must be provided under the Apache 2.0 License
Expand Down

0 comments on commit b861647

Please sign in to comment.