cylon/lib/generators/adaptor
Andrew Stewart 4c5937695b Add Cylon-provided globals to generated .jshintrc files 2014-03-03 14:41:05 -08:00
..
lib Clarify license year in generated adaptors 2014-03-03 14:32:01 -08:00
test Remove 'source loading:' log messages from tests 2014-02-27 20:59:21 -08:00
.gitignore Move generators from src to lib 2014-02-27 09:59:41 -08:00
.jshintrc Add Cylon-provided globals to generated .jshintrc files 2014-03-03 14:41:05 -08:00
LICENSE Move generators from src to lib 2014-02-27 09:59:41 -08:00
Makefile Update generator to create pure-JS adaptors 2014-02-27 10:46:58 -08:00
README.md.tpl Update generator to create pure-JS adaptors 2014-02-27 10:46:58 -08:00
package.json.tpl Update generator to create pure-JS adaptors 2014-02-27 10:46:58 -08:00

README.md.tpl

# Cylon.js For <%= adaptorClassName %>

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and
physical computing using Node.js

This repository contains the Cylon adaptor for <%= adaptorClassName %>.

Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)

Want to use the Go programming language to power your robots? Check out our
sister project Gobot (http://gobot.io).

For more information about Cylon, check out our repo at
https://github.com/hybridgroup/cylon

## Getting Started

Install the module with: `npm install <%= adaptorName %>`

## Examples

## Connecting

### JavaScript

```javascript
var Cylon = require('cylon');

Cylon.robot({
  connection: { name: '<%= basename %>', adaptor: '<%= basename %>' },
  device: {name: '<%= basename %>', driver: '<%= basename %>'},

  work: function(my) {
    // provide an example of your module here
  }
}).start();
```

### CoffeeScript

```
Cylon = require 'cylon'

Cylon.robot
  connection: { name: '<%= basename %>', adaptor: '<%= basename %>' }
  device: { name: '<%= basename %>', driver: '<%= basename %>' }

  work: (my) ->
    # provide an example of your module here

.start()
```

Explain how to connect from the computer to the device here...

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code
using `make test` and `make lint`.

## Release History

None yet...

## License

Copyright (c) 2014 Your Name Here. See `LICENSE` for more details