Skip to content
This repository has been archived by the owner on Feb 25, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olegp committed Jan 29, 2012
1 parent 335bc46 commit 6935f37
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Expand Up @@ -9,11 +9,9 @@ proposals on top of [Node.js](http://nodejs.org) using
* mix & match synchronous/asynchronous styles and use the best tool for the job by writing maintainable business logic in a synchronous manner
* write concise, legible shell scripts

If you have a spare 20 minutes, you can also check out [this presentation](http://www.slideshare.net/olegp/server-side-javascript-going-all-the-way) (audio included).
If you have a spare 20 minutes, you can also check out [this presentation](http://www.slideshare.net/olegp/server-side-javascript-going-all-the-way) (audio included). If you have any questions, you can find help on IRC, channel [#common-node](irc://irc.freenode.net/common-node) on freenode.

If you have any questions, you can find help on IRC, channel [#common-node](irc://irc.freenode.net/common-node) on freenode.

For a real world application using Common Node, take a look at the [Minimal CMS](https://github.com/olegp/mcms). If you're looking for an Express like framework that works with Common Node, take a look at [Stick](https://github.com/olegp/stick/), in particular the [skeleton app](https://github.com/olegp/stick/tree/master/examples/skeleton) in examples.
For a real world application using Common Node, take a look at the [Minimal CMS](https://github.com/olegp/mcms).

The following modules are included:

Expand All @@ -32,9 +30,9 @@ The following modules are included:

If you don't already have them, [install Node version 0.5.2 or later](https://github.com/joyent/node/wiki/Installation) (for Node 0.4.X check out the v0.4 branch of Common Node) and [Node Package Manager](http://npmjs.org). It's also highly recommended that you have your $NODE_PATH variable [set correctly](https://github.com/olegp/common-node/issues/20).

Install `common-node` as a global package:
Install `common-node` as a global package (use `sudo` if you're on Ubuntu):

sudo npm -g install common-node
npm -g install common-node

Run the "Hello World" example:

Expand All @@ -59,6 +57,10 @@ A number of examples are available in [common-node/examples](https://github.com/

For more usage examples, please refer to the tests in the [common-node/test](https://github.com/olegp/common-node/tree/master/test) directory.

If you're looking for an Express like framework that works with Common Node, take a look at [Stick](https://github.com/olegp/stick/), in particular the [skeleton app](https://github.com/olegp/stick/tree/master/examples/skeleton) in examples.

Common Node also works well with [CoffeeScript](http://coffeescript.org/), check out [this example](https://gist.github.com/1447709).

### Documentation

The API reference is available at <http://olegp.github.com/common-node/doc/>
Expand Down

0 comments on commit 6935f37

Please sign in to comment.