Skip to content

Commit

Permalink
Fixed package.json. Added npm install info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
josephg committed Apr 20, 2011
1 parent 7cee1ec commit e647343
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 5 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,23 @@ At the moment only plain-text is supported, but JSON and rich text should be sup

Check out [some cool demos](http://sharejs.org:8000/)


Installing and running
----------------------

npm install share

Run the examples with:

# sharejs-exampleserver

Run from node using:

var client = require('share').client;

or

var sharejs = require('share').server;

More proper docs incoming...

14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
{
"name": "sharejs",
"name": "share",
"version": "0.1.0",
"description": "A database for concurrent document editing",
"keywords": ["operational transformation", "ot", "concurrent", "collaborative", "database", "server"],
"homepage": "",
"author": "Joseph Gentle <[email protected]>",
"main": "lib/server/main.js",
"bin": { "sharejs": "bin/sharejs" },
"main": "lib/index.js",
"bin": {
"sharejs": "bin/sharejs",
"sharejs-exampleserver": "bin/exampleserver"
},
"dependencies": {
"socket.io": ">= 0.6.0",
"socket.io-node-client": "*",
"connect": ">= 1.1.1 < 2.0.0",
"jumprope": "~1.0.0rc1"
"coffee-script": "~1.0.0",
"redis": "*",
"nodeunit": "~0.5.0"
},
"licenses": [{
"type": "BSD",
Expand Down
2 changes: 2 additions & 0 deletions src/index.coffee
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
exports.server = require './server'
exports.client = require './client'

0 comments on commit e647343

Please sign in to comment.