diff --git a/README b/README index 0fb4d20..bf0cd0e 100644 --- a/README +++ b/README @@ -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..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. \ No newline at end of file