Skip to content

Commit

Permalink
Edited README via GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
nfolkert committed Sep 16, 2011
1 parent 147814d commit a4e6311
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README
Expand Up @@ -5,22 +5,19 @@ client credentials at https://foursquare.com/oauth). This caller object gets pa
UserlessApp (which makes all requests using only your client secret rather than an access token, so
only a limited set of endpoints are available) or an AuthApp (which requires a user's access token, thus
binding any requests made to that user). To get a user's access token, you need to go through one of the
oauth flows described at https://developer.foursquare.com/docs/oauth.html.
oauth flows described at https://developer.foursquare.com/docs/oauth.html. There is some support for building
the various oauth urls and making some calls in OAuthFlow.

These apps support multiple request types to interact with the foursquare server. All requests may be
made either raw (returning the json formatted string result of the call) or extracted into Scala case
classes. Basic call and extraction has been tested for all read-only endpoints and a few mutating ones.
Photo endpoints support uploading a photo file via POST. See CallTest for examples on how to make these
Photo endpoints support uploading a photo file via POST. See the test src for examples on how to make
various calls. Multi endpoint is also supported.

To run the tests, you will need to fill out the information missing in test.default.props file (you
should make a test.<username>.props file that will get ignored by git. Please do not submit any
credentials in the persisted test.default.props file).

There is an sbt 0.7 project as well as the beginning of an IntelliJ project. For IntelliJ users, this
should have the beginnings of the project, though you may need to construct some of the libraries and
the like.

Please note that this is an unofficial library. As of now I'm still playing around with it to see if it's useful.

Feel free to contact me if you have any questions. I am nfolkert at foursquare.

0 comments on commit a4e6311

Please sign in to comment.