Skip to content

Commit

Permalink
Adding usage, deployment, roadmap notes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejarema committed May 12, 2012
1 parent d94428d commit 6425b87
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Expand Up @@ -19,26 +19,34 @@ This project attempts to do so anyways.
It may or may not provide a "reasonable" result anytime you need to rank a list of friends.


## How To Use This Code on Heroku
## Usage

Once deployed (see deployment notes below) this web service has a single JSONP call of interest at the root URL.

http://facebook-friend-rank.herokuapp.com/?token=[fb-access-token]

This returns a hash of FB used IDs to a unitless score. Use the score value to sort your friend
lists, higher score means a "better" friend.

The returned hash may not contain entries for all friends, assume a zero value for these friends (worst).


## How To Deploy To Heroku

The following assumes you have a Heroku account in good standing, and have configured your development environment.

This repository is configured to use Memcachier out of the box. Cacheless/alternative cache deployments are not
supported yet (fork me!).

$ git clone git@github.com:mikejarema/facebook-friend-rank; cd facebook-friend-rank
Cloning into facebook-friend-rank... done.

$ heroku apps:create facebook-friend-rank --stack cedar --addons memcachier:25
Creating facebook-friend-rank... done, stack is cedar
Adding memcachier:25 to facebook-friend-rank... done
http://facebook-friend-rank.herokuapp.com/ | git@heroku.com:facebook-friend-rank.git
Git remote heroku added

$ git push heroku master

Then visit your heroku URL, eg. http://facebook-friend-rank.herokuapp.com/demo (TODO) and/or
make calls to the JSONP endpoint (see usage notes above).


## How To Use This Code Elsewhere
## How To Deploy Elsewhere

You're on your own here (fork me!).

Expand All @@ -47,6 +55,11 @@ You're on your own here (fork me!).

* Sample web app bundled with the web service

* Ensure all friends have a score in returned results

* Progressive update, crude results returned quickly with more accurate results being computed against that
access token for later use

* Error handling

* Specs
Expand Down

0 comments on commit 6425b87

Please sign in to comment.