help-fem/README.md

A Browserify/Node.js client module for the Help.com team's FEM.

help-fem.js
===========

A Browserify/Node.js client module for the Help.com team's FEM.

## Installation
`npm install help-fem`

## Creating a client.
Creating a client is very similar in style as creating Ampersand/Backbone models, views, etc.

```js
var HelpFem = require(HelpFem);

var FemClient = HelpFem.Client.extend({
  // Prototypical methods / properties.
}, {
  // Private methods / properties.
});

var femClient = new FemClient({
  uri: 'localhost:8080',
  namespace: 'my-namespace'
});
```

## Documentation
Check out the documentation on the repo's [GitHub page](http://helpdotcom.github.io/help-fem.js/).

## examples/basic
To run the basic example, do:

1. `npm install`
2. `cd examples/basic`
3. `npm install`
4. `browserify -o muscle/skeletal.bundle.js muscle/skeletal.js`
5. `npm start`
6. Point your browser to `localhost:8080`.