ffeed-0.2: README

= hsffeed - Programming FriendFeed from Haskell =

'hsffeed' is a Haskell package providing a binding to
the FriendFeed API - 

  http://friendfeed.com/api/
  http://code.google.com/p/friendfeed-api/wiki/ApiDocumentation

The binding is functionally complete (Nov 2008), letting you write
applications in Haskell that accesses and manipulates content on
FriendFeed and the sites it aggregates.

= Getting started =

For some code samples showing you how to get started using this
API binding, have a look in the examples/ directory. 

= Building and installing =

This package is provided in Cabal form, so only thing you need to
do to get going is:

  foo% runghc Setup configure
  foo% runghc Setup build 
  foo% runghc Setup install

The package depends on a bunch of other packages though, so you
need to have them built&installed, as well. They are:

  * HTTP: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/HTTP
  * json:  http://hackage.haskell.org/cgi-bin/hackage-scripts/package/json
  * utf8-string: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/utf8-string

= Authentication =

When using this API binding to build your own FriendFeed application, 
authenticated calls require a user's remote key. This key is available
to logged-in FriendFeed users via http://www.friendfeed.com/remotekey

= Feedback / question =

Please send them to sof@forkIO.com , and I'll try to respond to them
as best/quickly as possible.