UNPKG

2.17 kBMarkdownView Raw
1Discogs: A simple JavaScript wrapper for the Discogs API
2========================================================
3
4`discogs` is a simple wrapper for the [Discogs API](http://www.discogs.com/help/api), written in CoffeeScript and usable in e.g. Node.js.
5
6## Version
70.2.0
8
9## Requirements
10
11- [Node](http://github.com/ry/node)
12- [request](http://github.com/mikeal/request)
13- [node-compress](http://github.com/waveto/node-compress)
14
15## Installation
16
17Recommended installation is using [npm](http://github.com/isaacs/npm)
18
19 npm bundle discogs
20
21## Usage
22
23 var discogs = require('discogs');
24
25 var client = discogs({api_key: 'foo4711'});
26
27 client.artist('Marcus Price', function(err, artist) {
28 console.log(artist.name); // Marcus Price
29 });
30
31## Credits
32
33Linus G Thiel <linus@hanssonlarsson.se>
34
35## Thank you
36
37- [Discogs](http://discogs.com/) for an outstanding service and a great API
38- [Ryan Dahl](http://github.com/ry) for the awesome Node.js
39- [Jeremy Ashkenas](http://github.com/jashkenas) for the beautiful CoffeeScript
40
41## License
42
43(The MIT License)
44
45Copyright (c) 2010 Hansson & Larsson <info@hanssonlarsson.se>
46
47Permission is hereby granted, free of charge, to any person obtaining
48a copy of this software and associated documentation files (the
49'Software'), to deal in the Software without restriction, including
50without limitation the rights to use, copy, modify, merge, publish,
51distribute, sublicense, and/or sell copies of the Software, and to
52permit persons to whom the Software is furnished to do so, subject to
53the following conditions:
54
55The above copyright notice and this permission notice shall be
56included in all copies or substantial portions of the Software.
57
58THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
59EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
60MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
61IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
62CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
63TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
64SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.