From: Chip Black Date: Tue, 19 Jul 2011 02:35:25 +0000 (-0500) Subject: Documentation for 1.6 X-Git-Tag: v1.6 X-Git-Url: http://git.bytex64.net/?a=commitdiff_plain;ds=inline;h=cdcf2e46dea2a2cc210caeb10a951ea8cf5d0e26;p=blerg.git Documentation for 1.6 --- diff --git a/www/doc/changelog.html b/www/doc/changelog.html index b1359f6..30e406a 100644 --- a/www/doc/changelog.html +++ b/www/doc/changelog.html @@ -11,6 +11,23 @@ The intent of this changelog is to give an overview of the major changes and fixes made to Blërg. For a detailed changelog, see the git log. +

Version 1.6 - released Monday, July 18th 2011

+ +

Features Added

+ + +

Bugs Squashed

+ +

Version 1.5 - released Friday, March 4th 2011

Features Added

diff --git a/www/doc/index.html b/www/doc/index.html index 21982bd..9dc8c07 100644 --- a/www/doc/index.html +++ b/www/doc/index.html @@ -39,7 +39,7 @@ C.
  • /subscribe/(user) - Subscribe to a user's updates
  • /unsubscribe/(user) - Unsubscribe from a user's updates
  • /feed - Get updates for subscribed users
  • -
  • /feedinfo/(user) - Get subscription status for a user
  • +
  • /feedinfo, /feedinfo/(user) - Get subscription status
  • Design @@ -304,15 +304,26 @@ a user's updates

    POST to /feed, with a username 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.

    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. -

    /feedinfo/(user) - Get subscription +

    /feedinfo, /feedinfo/(user) - Get subscription status for a user

    +

    POST to /feedinfo with a username 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: + +

    +{"new":3}
    +
    +

    POST to /feedinfo/(user) with a username 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: