Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[docs] Updating README

  • Loading branch information...
commit abc7320b5ce1c787339f1c2a84aab21ead762c3d 1 parent 2748fa1
Marak authored

Showing 1 changed file with 8 additions and 8 deletions. Show diff stats Hide diff stats

  1. +8 8 README.md
16 README.md
Source Rendered
... ... @@ -1,8 +1,7 @@
  1 +# Experimental / Unreleased
1 2
2 3 # sockful
3 4
4   -[![Build Status](https://secure.travis-ci.org/flatiron/sockful.png)](http://travis-ci.org/flatiron/sockful)
5   -
6 5 Creates [socket.io](http://socket.io) servers and event maps for [resourceful](http://github.com/flatiron/resourceful) resources. Can be used as a stand-alone module or as a [Flatiron](http://github.com/flatiron/) plugin.
7 6
8 7 # Explanation
@@ -52,13 +51,13 @@ socket.emit('creature', 'create', { id: 'bob' } , function(err, bob) {
52 51 };
53 52 ```
54 53
55   - Socket Event Action
  54 + Socket Event Action
56 55
57   - socket.emit('creature', 'create', data, callback) => Creature.create()
58   - socket.emit('creature', 'get', data, callback) => Creature.get()
59   - socket.emit('creature', 'all', data, callback) => Creature.all()
60   - socket.emit('creature', 'update', data, callback) => Creature.update()
61   - socket.emit('creature', 'destroy', data, callback) => Creature.destroy()
  56 + socket.emit('creature', 'create', data, callback) => Creature.create()
  57 + socket.emit('creature', 'get', data, callback) => Creature.get()
  58 + socket.emit('creature', 'all', data, callback) => Creature.all()
  59 + socket.emit('creature', 'update', data, callback) => Creature.update()
  60 + socket.emit('creature', 'destroy', data, callback) => Creature.destroy()
62 61
63 62
64 63 The socket server will delegate all incoming Creature events to the resource and respond back with the appropriate result.
@@ -117,6 +116,7 @@ There are several ways to provide security and authorization for accessing resou
117 116
118 117 - Full `resourceful` property type support ( numeric, boolean, array, object )
119 118 - Full `resourceful` nested property schema support
  119 + - Better browser / isomorphic support
120 120 - Add ability to specify schemas for remote method argument payloads
121 121 - Improve Tests
122 122 - Add better error support via `errs` library

0 comments on commit abc7320

Please sign in to comment.
Something went wrong with that request. Please try again.