Skip to content

Commit

Permalink
Added README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Reagan committed Oct 26, 2009
1 parent 7e4e187 commit 2f3d66c
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# An Example Rails Application

This application is designed to demonstrate how one might use the [Fleakr gem](http://github.com/reagent/fleakr)
to retrieve data from the Flickr API on behalf of an individual user. This is really just a proof-of-concept of
how you would go about implementing this integration, you wouldn't want to do this on an actual application as
it's *horribly* slow and would likely get you locked out of the Flickr API with even moderate use.

## Configuration

To get started, you'll need to set up an API key and secret from your Flickr account (see the gem documentation for
full details on how to do this). When configuring your callback URL, you can use `http://localhost:3000/login` if
you're using `script/server` to run the application.

Steps to run:

1. Rename `initializers/fleakr.rb.example` to `initializers/fleakr.rb` and provide the information from your newly
created API key
1. Run `script/server` to boot Mongrel
1. Point your browser to http://localhost:3000/

Once you authorize your Flickr account, you can browse the photos and sets that you have available as part of your
account.

## Credits

Copyright 2009 Patrick Reagan (reaganpr@gmail.com)
2 changes: 0 additions & 2 deletions doc/README_FOR_APP

This file was deleted.

0 comments on commit 2f3d66c

Please sign in to comment.