Documentation for 1.6

[blerg.git] / www / doc / index.html

diff --git a/www/doc/index.html b/www/doc/index.html
index 21982bd..9dc8c07 100644 (file)
--- a/www/doc/index.html
+++ b/www/doc/index.html
@@ -39,7 +39,7 @@ C.
       <li><a href="#api_subscribe">/subscribe/(user) - Subscribe to a user's updates</a></li>
       <li><a href="#api_unsubscribe">/unsubscribe/(user) - Unsubscribe from a user's updates</a></li>
       <li><a href="#api_feed">/feed - Get updates for subscribed users</a></li>
-      <li><a href="#api_feedinfo">/feedinfo/(user) - Get subscription status for a user</a></li>
+      <li><a href="#api_feedinfo">/feedinfo, /feedinfo/(user) - Get subscription status</a></li>
     </ul>
   </li>
   <li><a href="#design">Design</a>
@@ -304,15 +304,26 @@ a user's updates</h3>
 
 <p>POST to /feed, with a <code>username</code> parameter and an auth
 cookie.  The server will respond with a JSON list of the last 50 updates
-from all subscribed users, in reverse chronological order.
+from all subscribed users, in reverse chronological order.  Fetching
+/feed resets the new message count returned from /feedinfo.
 
 <p>NOTE: subscription notifications are only stored while subscriptions
 are active.  Any records inserted before or after a subscription is
 active will not show up in /feed.
 
-<h3><a name="api_feedinfo">/feedinfo/(user)</a> - Get subscription
+<h3><a name="api_feedinfo">/feedinfo, /feedinfo/(user)</a> - Get subscription
 status for a user</a></h3>
 
+<p>POST to /feedinfo with a <code>username</code> parameter and an auth
+cookie to get general information about your subscribed feeds.
+Currently, this only tells you how many new records there are since the
+last time /feed was fetched.  The server will respond with a JSON
+object:
+
+<pre>
+{"new":3}
+</pre>
+
 <p>POST to /feedinfo/(user) with a <code>username</code> parameter and
 an auth cookie, where (user) is a user whose subscription status you are
 interested in.  The server will respond with a simple JSON object: