From 6dd7564f587200f2857fbe28a8615b015b7b7bb8 Mon Sep 17 00:00:00 2001 From: Alexey Simonenko Date: Tue, 8 Jan 2013 21:48:01 +0400 Subject: [PATCH] Update readme --- readme.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index 6c8c346..6bb7f70 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # 4sq -A Node.JS wrapper for [Foursquare API](https://developer.foursquare.com/overview/). +A Node.JS wrapper for the [Foursquare API](https://developer.foursquare.com/overview/). How to use with JavaScript -------------------------- @@ -32,27 +32,23 @@ fsq.checkins 'self', limit: 5, (error, data) -> console.log data ``` +---------------- + Install with NPM ---------------- -``` -npm install 4sq -``` + npm install 4sq How to retrieve Foursquare OAuth2 access_token ------------------------------------------- +---------------------------------------------- Grab latest source code and install all dev dependencies -``` -npm link -``` + npm link Change your host, client id, client secret in [examples/get-access-token.coffee](http://github.com/meritt/node-4sq/blob/master/examples/get-access-token.coffee) and after that run [examples/get-access-token.coffee](http://github.com/meritt/node-4sq/blob/master/examples/get-access-token.coffee) -``` -coffee examples/get-access-token.coffee -``` + coffee examples/get-access-token.coffee API --- @@ -64,4 +60,4 @@ API Author ------ -* Alexey Simonenko, dwarfman@gmail.com \ No newline at end of file +* [Alexey Simonenko](mailto:alexey@simonenko.su), [simonenko.su](http://simonenko.su) \ No newline at end of file