Is there an example app for this package?

[syang]

It would be great if we can find run

$npm install
$npm start

and then the localhost:3000 will be running as the example.

Looking at this repo, I don't see such an example. Could you give a pointer to the example app that uses this package?

[dschinkel]

agree, the docs suck, I can't use this.

[FullStackForger]

Hey. Thanks for the comments. Sorry for massive delay with the answer.

This package is not meant to be used on it's own. It is a plugin for react and this repository only hosts source code and unit test which should serve you better than any docs. Npm is only used for running tests.

If you looking for usage example you can take a look at fs-react-starter-pack which uses this package.

That being said I am quite open to adding extra info into documentation if need. Is there anything in particular you would like to see there?