X-Git-Url: http://git.bytex64.net/?a=blobdiff_plain;f=www%2Fdoc%2Findex.html;h=5a170e6d7cd596db930a9612b9f8cd24c2e6cc30;hb=a88ac56feb7930b575668d20f31285d83da95893;hp=21982bd108abaf79adb59c0f5b8dbfeda613f9a9;hpb=dfd9f2ccb8a86e20401c2d789bd4152786484024;p=blerg.git diff --git a/www/doc/index.html b/www/doc/index.html index 21982bd..5a170e6 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 @@ -86,10 +86,15 @@ sense of humor, requires ruby to compile)
  • Configuring

    -

    I know I'm gonna get shit for not using an autoconf-based system, but -I really didn't want to spend time figuring it out. You should edit -libs.mk and put in the paths where you can find headers and libraries -for the above requirements. +

    There is now an experimental autoconf build system. If you run +add-autoconf, it'll do the magic and create a +configure script that'll do the familiar things. If I ever +get around to distributing source packages, you should find that this +has already been done. + +

    If you'd rather stick with the manual system, you should edit libs.mk +and put in the paths where you can find headers and libraries for the +above requirements.

    Also, further apologies to BSD folks — I've probably committed several unconscious Linux-isms. It would not surprise me if the @@ -304,15 +309,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: