document that history / presence are WIP

Colingo · Jan 16, 2013 · 54b53e3 · 54b53e3
1 parent f9850f6
commit 54b53e3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/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

diff --git a/history.js b/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({

diff --git a/presence.js b/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)