Update to version 0.1.0
This commit is contained in:
parent
4268a25ad7
commit
b29f911628
11
README.md
11
README.md
|
@ -12,10 +12,11 @@ Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)
|
||||||
|
|
||||||
Install the module with: `npm install cylon`
|
Install the module with: `npm install cylon`
|
||||||
|
|
||||||
|
Then install modules for whatever hardware support you want to use from your robot. For example, `npm install cylon-firmata` to use Cylon with an Arduino using the Firmata protocol.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
**Note:** before running examples in the `examples/` dir, make sure to compile
|
**Note:** before running examples in the `examples/` dir from source, make sure to compile using `grunt coffee` first.
|
||||||
the source with `grunt coffee` first.
|
|
||||||
|
|
||||||
### Javascript:
|
### Javascript:
|
||||||
```javascript
|
```javascript
|
||||||
|
@ -61,6 +62,10 @@ Cylon.js has a extensible system for connecting to hardware devices. The followi
|
||||||
- [Arduino](http://www.arduino.cc/) <=> [Adaptor](https://github.com/hybridgroup/cylon-firmata)
|
- [Arduino](http://www.arduino.cc/) <=> [Adaptor](https://github.com/hybridgroup/cylon-firmata)
|
||||||
- [Sphero](http://www.gosphero.com/) <=> [Adaptor](https://github.com/hybridgroup/cylon-sphero)
|
- [Sphero](http://www.gosphero.com/) <=> [Adaptor](https://github.com/hybridgroup/cylon-sphero)
|
||||||
|
|
||||||
|
Support for common shared device drivers, is provded using the General Purpoer Input/Output (GPIO) module:
|
||||||
|
|
||||||
|
- [GPIO] <=> [Drivers](https://github.com/hybridgroup/cylon-gpio)
|
||||||
|
|
||||||
More platforms are coming soon!
|
More platforms are coming soon!
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
@ -72,7 +77,7 @@ Add unit tests for any new or changed functionality. Lint and test your code
|
||||||
using [Grunt](http://gruntjs.com/).
|
using [Grunt](http://gruntjs.com/).
|
||||||
|
|
||||||
## Release History
|
## Release History
|
||||||
_(Nothing yet)_
|
Version 0.1.0 - Initial release for ongoing development
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Copyright (c) 2013 The Hybrid Group. Licensed under the Apache 2.0 license.
|
Copyright (c) 2013 The Hybrid Group. Licensed under the Apache 2.0 license.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
{
|
{
|
||||||
"name": "cylon",
|
"name": "cylon",
|
||||||
"version": "0.0.0",
|
"version": "0.1.0",
|
||||||
"main": "dist/cylon.js",
|
"main": "dist/cylon.js",
|
||||||
"description": "A JavaScript robotics framework for node.js",
|
"description": "A JavaScript robotics framework using node.js",
|
||||||
"homepage": "http://cylonjs.com",
|
"homepage": "http://cylonjs.com",
|
||||||
"bugs": "https://github.com/hybridgroup/cylon/issues",
|
"bugs": "https://github.com/hybridgroup/cylon/issues",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Ron Evans",
|
"name": "Ron Evans, Andrew Stewart, Edgar Silva",
|
||||||
"email": "",
|
"email": "cylonjs@hybridgroup.com",
|
||||||
"url": "http://hybridgroup.com"
|
"url": "http://hybridgroup.com"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|
Loading…
Reference in New Issue