<NME> README.md
<BEF> Raspi Core
==========

Raspi Core provides base support for the Raspberry Pi. This module automatically downloads and installs [Wiring Pi](http://wiringpi.com/) to provide access to the hardware.

Install with ```npm install raspi-core```. Note: you may need to install [node-gyp](https://www.npmjs.org/package/node-gyp) manually: ```npm install -g node-gyp```.

This module exposes a single method, ```init```, that initializes Wiring PI. It takes a single callback as its arguments, to be called once initialization is complete, as shown below:

```JavaScript
var raspiCore = require('raspi-core');
```

**Note:** this project is written in [TypeScript](http://www.typescriptlang.org/) and includes type definitions in the package.json file. This means that if you want to use it from TypeScript, you don't need to install a separate @types module.
});
```

The intent of this module is to form the basis for a set of other modules that expose various peripheral APIs. Check out:

* [Raspi GPIO](https://github.com/bryan-m-hughes/raspi-gpio): Basic GPIO access

License
=======

import { init } from 'raspi';
import { DigitalInput, DigitalOutput } from 'raspi-gpio';

init(() => {
  const input = new DigitalInput('P1-3');
  const output = new DigitalOutput('P1-5');
  output.write(input.read());
});
```

in JavaScript:

```JavaScript
const raspi = require('raspi');
const gpio = require('raspi-gpio');

raspi.init(() => {
  const input = new gpio.DigitalInput('P1-3');
  const output = new gpio.DigitalOutput('P1-5');
  output.write(input.read());
});
```

## API

### Module Constants

<table>
  <thead>
    <tr>
      <th>Constant</th>
      <th>Description</th>
    </tr>
  </thead>
  <tr>
    <td>module</td>
    <td>An easily consumable object for indirectly passing this module around. Intended specifically for use by Core IO (details coming soon)</td>
  </tr>
  <tr>
    <td></td>
    <td><table>
      <thead>
        <tr>
          <th>Property</th>
          <th>Type</th>
          <th>Description</th>
        </tr>
      </thead>
      <tr>
        <td>init</td>
        <td>Alias of the <a href="#init">init</a> method</td>
      </tr>
    </table></td>
  </tr>
</table>

### init(cb)

The ```init``` method initializes the library suite. This method MUST be called before using any peripherals.

_Arguments_:

<table>
  <thead>
    <tr>
      <th>Argument</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tr>
    <td>cb</td>
    <td>Function</td>
    <td>Callback to be called once the board has been initialized. Takes no arguments</td>
  </tr>
  <tr>
    <td></td>
    <td colspan="2">
      <table>
        <tr><td>Takes no arguments</td></tr>
      </table>
    </td>
  </tr>
</table>

_Returns_: None

License
=======

The MIT License (MIT)

Copyright (c) 2014-2017 Bryan Hughes <bryan@nebri.us>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

<MSG> First round of README updates

<DFF> @@ -1,11 +1,36 @@
 Raspi Core
 ==========
 
-Raspi Core provides base support for the Raspberry Pi. This module automatically downloads and installs [Wiring Pi](http://wiringpi.com/) to provide access to the hardware.
+Raspi Core provides base support for the Raspberry Pi for the raspi suite of libraries. These libraries form the basis for [Raspi IO](https://github.com/bryan-m-hughes/raspi-io), an IO plugin that adds support for the Raspberry Pi to [Johnny-Five](https://github.com/rwaldron/johnny-five).
 
-Install with ```npm install raspi-core```. Note: you may need to install [node-gyp](https://www.npmjs.org/package/node-gyp) manually: ```npm install -g node-gyp```.
+This module, along with [Raspi Board](https://github.com/bryan-m-hughes/raspi-board) and [Raspi Peripheral](https://github.com/bryan-m-hughes/raspi-peripheral) forms the basis for a suite of modules that provide support for various peripherals.
 
-This module exposes a single method, ```init```, that initializes Wiring PI. It takes a single callback as its arguments, to be called once initialization is complete, as shown below:
+Check out the following peripheral API modules:
+
+* [Raspi GPIO](https://github.com/bryan-m-hughes/raspi-gpio)
+* [Raspi PWM](https://github.com/bryan-m-hughes/raspi-pwm)
+* [Raspi I2C](https://github.com/bryan-m-hughes/raspi-i2c)
+
+## Installation
+
+Install with NPM:
+
+```Shell
+npm install raspi-core
+```
+
+In rare cases, you may need to install [node-gyp](https://www.npmjs.org/package/node-gyp) manually:
+
+```Shell
+npm install -g node-gyp
+```
+
+## API
+
+This module exposes a single method, ```init```, that initializes the library suite. It takes a single callback as its arguments, to be called once initialization is complete, as shown below:
+
+
+## Example Usage
 
 ```JavaScript
 var raspiCore = require('raspi-core');
@@ -15,10 +40,6 @@ raspiCore.init(function() {
 });
 ```
 
-The intent of this module is to form the basis for a set of other modules that expose various peripheral APIs. Check out:
-
-* [Raspi GPIO](https://github.com/bryan-m-hughes/raspi-gpio): Basic GPIO access
-
 License
 =======
 

First round of README updates