From: Chip Black <bytex64@bytex64.net>
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.
 
+<a name="v1.6"><h2>Version 1.6 - released Monday, July 18th 2011</h2>
+
+<h3>Features Added</h3>
+<ul>
+<li>Passwords are now stored as MD5 hashes. See
+tools/convert_to_md5_passwords.pl to convert old passwords.</li>
+<li>Added notification of new messages from subscribed feeds.</li>
+</ul>
+
+<h3>Bugs Squashed</h3>
+<ul>
+<li>Users can now log in from multiple locations without clobbering
+their previous login.</li>
+<li>Fixed some relative URL problems so that Blërg can be more easily
+used on a subpath.</li>
+</ul>
+
 <a name="v1.5"><h2>Version 1.5 - released Friday, March 4th 2011</h2>
 
 <h3>Features Added</h3>
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.
       <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: