Browse files

document that history / presence are WIP

  • Loading branch information...
1 parent f9850f6 commit 54b53e39635666dda7181ced39ad73ef4c8f1da2 @Raynos Raynos committed Jan 16, 2013
Showing with 15 additions and 0 deletions.
  1. +11 −0 README.md
  2. +2 −0 history.js
  3. +2 −0 presence.js
View
11 README.md
@@ -26,6 +26,17 @@ subscribed
published.write({ some: "data" })
```
+## Api surface
+
+ - publish
+ - subscribe
+ - duplex
+
+## Work in progress
+
+ - history
+ - presence
+
## Known issues
- Sometimes you get the same published message multiple times
View
2 history.js
@@ -3,6 +3,8 @@ var ReadStream = require("read-stream")
module.exports = history
function history(client, channel, limit) {
+ throw new Error("not implemented / tested")
+
var queue = ReadStream()
client.history({
View
2 presence.js
@@ -11,6 +11,8 @@ var EXPIRY_SUFFIX = "-expmodel"
module.exports = presence
function presence(client, channel, options) {
+ throw new Error("not implemented / tested")
+
var model = ExpiryModel(options)
var presenceStream = subscribe(client, channel + PRESENCE_SUFFIX)

0 comments on commit 54b53e3

Please sign in to comment.