Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 61 lines (45 sloc) 2.099 kB
d7bb0ba @olalonde Update README.md
authored
1 [![NPM version](https://badge.fury.io/js/yelp.png)](http://badge.fury.io/js/yelp)
2
1930b8e @olalonde edited README
authored
3 Node.js module for interfacing with [Yelp](http://www.yelp.com)'s API v2.0
4
5 # Install #
6
add8839 @olalonde Update README.md
authored
7 npm install --save yelp
1930b8e @olalonde edited README
authored
8
9 # Usage #
10
add8839 @olalonde Update README.md
authored
11 ```javascript
12 // Request API access: http://www.yelp.com/developers/getting_started/api_access
13
14 var yelp = require("yelp").createClient({
15 consumer_key: "consumer-key",
16 consumer_secret: "consumer-secret",
17 token: "token",
18 token_secret: "token-secret"
19 });
20
21 // See http://www.yelp.com/developers/documentation/v2/search_api
22 yelp.search({term: "food", location: "Montreal"}, function(error, data) {
23 console.log(error);
24 console.log(data);
25 });
26
27 // See http://www.yelp.com/developers/documentation/v2/business
28 yelp.business("yelp-san-francisco", function(error, data) {
29 console.log(error);
30 console.log(data);
31 });
32 ```
33
95a9064 @olalonde published to npm
authored
34 # References #
35
36 - [Search API](http://www.yelp.com/developers/documentation/v2/search_api)
37 - [Business API](http://www.yelp.com/developers/documentation/v2/business)
aa8c067 @olalonde added license
authored
38
39 # License #
40
41 Copyright (c) 2012 Olivier Lalonde <olalonde@gmail.com>
42
43 Permission is hereby granted, free of charge, to any person obtaining a
44 copy of this software and associated documentation files (the
45 "Software"), to deal in the Software without restriction, including
46 without limitation the rights to use, copy, modify, merge, publish,
47 distribute, sublicense, and/or sell copies of the Software, and to
48 permit persons to whom the Software is furnished to do so, subject to
49 the following conditions:
50
51 The above copyright notice and this permission notice shall be included
52 in all copies or substantial portions of the Software.
53
54 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
55 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
56 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
57 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
58 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
59 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
60 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.