Skip to content
Newer
Older
100644 583 lines (420 sloc) 18.5 KB
bd37800 @tylergaw Travis badge and failing test for Travis
authored Apr 29, 2015
1 # Jribbble [![Build Status](https://travis-ci.org/tylergaw/jribbble.svg)](https://travis-ci.org/tylergaw/jribbble)
c27bc7f @tylergaw Quick readme update
authored May 26, 2015
2 A jQuery plugin to retrieve info from the [Dribbble API](http://developer.dribbble.com/v1/)
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
3
737a902 @tylergaw Coupla demos
authored May 17, 2015
4 Live demos available on [Codepen.io](http://codepen.io/collection/nWvjrg/)
5
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
6 ## Dependencies
2f1e53a @tylergaw Working on the readme
authored May 17, 2015
7 * jQuery 1.8+
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
8
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
9 ## Getting Jribbble
92250a7 @tylergaw Starting to get tests and travis in place
authored Apr 29, 2015
10
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
11 with Bower
92250a7 @tylergaw Starting to get tests and travis in place
authored Apr 30, 2015
12 ```
3cbe5e5 @tylergaw Writing docs
authored May 17, 2015
13 bower install --save jribbble
92250a7 @tylergaw Starting to get tests and travis in place
authored Apr 30, 2015
14 ```
15
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
16 or direct download:
5193ef5 @tylergaw links to dist files
authored May 26, 2015
17 - [jribbble.min.js](https://github.com/tylergaw/jribbble/blob/master/dist/jribbble.min.js)
18 - [jribbble.js](https://github.com/tylergaw/jribbble/blob/master/dist/jribbble.js)
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
19
20 ## Using Jribbble
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
21 Jribbble covers all non-authenticated methods of the [Dribbble API](http://developer.dribbble.com/v1/). All available methods are accessed from the `jribbble` object which is a member of the `jQuery` or `$` object.
22
23 *Note:* If you need access to Dribbble methods using `POST` or `PUT` you will need
24 to access the API using OAuth. Jribbble only supports unauthenticated `GET` methods.
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
25
c27bc7f @tylergaw Quick readme update
authored May 26, 2015
26 ```html
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
27 <body>
28 <script src="https://code.jquery.com/jquery-2.1.3.min.js"></script>
29 <script src="jribbble.min.js"></script>
30
31 <script>
737a902 @tylergaw Coupla demos
authored May 18, 2015
32 function success(apiResponse) {
33 // do cool stuff with apiResponse
34 };
35
36 function error(jqxhr) {
37 // Handle errors
38 };
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
39 // To use Jribbble you will need to register an application at:
40 // https://dribbble.com/account/applications/new
41 // Before calling any methods of jribbble you must set your
42 // dribbble client access token
43 $.jribbble.setToken('<your_dribbble_client_access_token>');
4786b86 @tylergaw So much more documentation
authored May 25, 2015
44
45 // Jribbble methods return a promise
737a902 @tylergaw Coupla demos
authored May 18, 2015
46 $.jribbble.shots().then(success, error);
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
47 </script>
48 </body>
49 ```
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
50
f2c434b @tylergaw More examples
authored May 17, 2015
51 ## Setting your app's client access token
52 Before you can use any of Jribbble's methods, you must set your Dribbble app's client access token.
53 If you do not have a token, create a new app at [https://dribbble.com/account/applications/new](https://dribbble.com/account/applications/new)
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
54
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
55 #### `$.jribbble.setToken(token)`
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
56
f2c434b @tylergaw More examples
authored May 18, 2015
57 **Description:** Sets the required Dribbble application client access token.
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
58
59 **Parameters:**
60 - token - *required* `String or Int` Your Dribbble App client access token
61
62 **Example usage:**
63 ```javascript
64 $.jribbble.setToken('123456789');
65 ```
66
f2c434b @tylergaw More examples
authored May 18, 2015
67 ## Available methods
68
93aefbe @tylergaw likes docs
authored May 25, 2015
69 #### Shots
9383247 @tylergaw more docs
authored May 25, 2015
70 - [$.jribbble.shots](#jribbbleshotsid-options)
71 - [$.jribbble.shots.attachments](#jribbbleshotsshotidattachmentsattachmentid-options)
72 - [$.jribbble.shots.buckets](#jribbbleshotsshotidbucketsoptions)
73 - [$.jribbble.shots.comments](#jribbbleshotsshotidcommentscommentid-options)
74 - [$.jribbble.shots.comments.likes](#jribbbleshotsshotidcommentscommentidlikesoptions)
84d7ccc @tylergaw Projects example
authored May 25, 2015
75 - [$.jribbble.shots.likes](#jribbbleshotsshotidlikesoptions)
76 - [$.jribbble.shots.projects](#jribbbleshotsshotidprojectsoptions)
ae8bd10 @tylergaw rebounds docs
authored May 25, 2015
77 - [$.jribbble.shots.rebounds](#jribbbleshotsshotidreboundsoptions)
93aefbe @tylergaw likes docs
authored May 25, 2015
78
79 #### Users
80
310ff01 @tylergaw Users examples
authored May 26, 2015
81 - [$.jribbble.users](#jribbbleusersuserid)
6e47b7e @tylergaw Missed a few shots examples
authored Jun 4, 2015
82 - [$.jribbble.users.shots](#jribbbleusersuseridshotsoptions)
310ff01 @tylergaw Users examples
authored May 26, 2015
83 - [$.jribbble.users.buckets](#jribbbleusersuseridbucketsoptions)
6e47b7e @tylergaw Missed a few shots examples
authored Jun 4, 2015
84 - [$.jribbble.users.projects](#jribbbleusersuseridprojectsoptions)
85 - [$.jribbble.users.teams](#jribbbleusersuseridteamsoptions)
86 - [$.jribbble.users.likes](#jribbbleusersuseridlikesoptions)
310ff01 @tylergaw Users examples
authored May 26, 2015
87 - [$.jribbble.users.followers](#jribbbleusersuseridfollowersoptions)
88 - [$.jribbble.users.following](#jribbbleusersuseridfollowingoptions)
89 - [$.jribbble.users.isFollowing](#jribbbleusersuseridisfollowingtargetuserid)
90
93aefbe @tylergaw likes docs
authored May 25, 2015
91 #### Teams
92
d912579 @tylergaw Teams examples
authored May 26, 2015
93 - [$.jribbble.teams.members](#jribbbleteamsteamidmembersoptions)
94 - [$.jribbble.teams.shots](#jribbbleteamsteamidshotsoptions)
95
93aefbe @tylergaw likes docs
authored May 25, 2015
96 #### Buckets
97
1f65b7f @tylergaw buckets docs
authored May 25, 2015
98 - [$.jribbble.buckets](#jribbblebucketsbucketid)
99 - [$.jribbble.buckets.shots](#jribbblebucketsbucketidshotsoptions)
100
93aefbe @tylergaw likes docs
authored May 25, 2015
101 #### Projects
9383247 @tylergaw more docs
authored May 25, 2015
102
218ca43 @tylergaw Typo in url
authored May 25, 2015
103 - [$.jribbble.projects](#jribbbleprojectsprojectid)
104 - [$.jribbble.projects.shots](#jribbbleprojectsprojectidshotsoptions)
4786b86 @tylergaw So much more documentation
authored May 26, 2015
105
106 ### Shots
107
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
108 #### `$.jribbble.shots(id, options)`
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
109
110 **Description:** Gets a list of shots.
111
112 **Parameters:**
113 - id - *optional* `String or Int` A shot id or a shot list name. See [API Docs](http://developer.dribbble.com/v1/shots/#list-shots) for list names.
114 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. See [API Docs](http://developer.dribbble.com/v1/shots/#list-shots) for a full list.
115
116 **Example usage:**
117 ```javascript
118 // Get a single shot
f2c434b @tylergaw More examples
authored May 18, 2015
119 $.jribbble.shots(2055068).then(function(res) {
120 // Do cool stuff with response
121 });
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
122 ```
9383247 @tylergaw more docs
authored May 25, 2015
123 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/KpMmjZ?editors=101).
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
124
125 ```javascript
126 // Get the second page of debut shots from the past month sorted by number of
127 // views at 35 per page.
128 $.jribbble.shots('debuts', {
129 'sort': 'views',
130 'timeframe': 'month',
9d37303 @tylergaw Seeing if I can embed an iframe in the readme
authored May 17, 2015
131 'per_page': 35
f2c434b @tylergaw More examples
authored May 18, 2015
132 }).then(function(res) {
133 // Do cool stuff with response
3cbe5e5 @tylergaw Writing docs
authored May 18, 2015
134 });
135 ```
136
9383247 @tylergaw more docs
authored May 25, 2015
137 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/RPRVew/?editors=101).
9d37303 @tylergaw Seeing if I can embed an iframe in the readme
authored May 18, 2015
138
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
139 #### `$.jribbble.shots(shotId).attachments(attachmentId, options)`
f2c434b @tylergaw More examples
authored May 18, 2015
140
141 **Description:** Gets the attachments or single attachment for a shot.
142
143 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
144 - shotId - *required* `String or Int`
348fe3a @tylergaw First examples for comments
authored May 18, 2015
145 - attachmentId - *optional* `String or Int` Only required if you want a single attachment. `options` are not rejected, but will have no effect when `attachmentId` is used.
f2c434b @tylergaw More examples
authored May 18, 2015
146 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Attachments only support paging options. `per_page` and `page`.
147
148 **Example usage:**
149 ```javascript
150 // Get all attachments for a shot
151 $.jribbble.shots(2066347).attachments().then(function(res) {
152 // Do cool stuff with response
153 });
154 ```
9383247 @tylergaw more docs
authored May 25, 2015
155 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/XbKgJy/?editors=101).
f2c434b @tylergaw More examples
authored May 18, 2015
156
157 ```javascript
158 // Get a single attachment for a shot
159 $.jribbble.shots(2066347).attachments(370029).then(function(res) {
160 // Do cool stuff with response
161 });
162 ```
163
9383247 @tylergaw more docs
authored May 25, 2015
164 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/ZGOyGM/?editors=101).
f2c434b @tylergaw More examples
authored May 18, 2015
165
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
166 #### `$.jribbble.shots(shotId).buckets(options)`
167
168 **Description:** Gets the buckets for a shot.
169
170 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
171 - shotId - *required* `String or Int`
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
172 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Buckets only support paging options. `per_page` and `page`.
173
174 **Example usage:**
175 ```javascript
176 // Get all buckets for a shot at 36 per page
177 $.jribbble.shots(2067006).buckets({'per_page': 36}).then(function(res) {
178 // Do cool stuff with response
179 });
180 ```
181
9383247 @tylergaw more docs
authored May 25, 2015
182 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/ZGOayV/?editors=101).
7c47547 @tylergaw Adding buckets example
authored May 18, 2015
183
348fe3a @tylergaw First examples for comments
authored May 19, 2015
184 #### `$.jribbble.shots(shotId).comments(commentId, options)`
185
186 **Description:** Gets the comments or single comment for a shot.
187
188 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
189 - shotId - *required* `String or Int`
348fe3a @tylergaw First examples for comments
authored May 19, 2015
190 - commentId - *optional* `String or Int` Only required if you want a single comment. `options` are not rejected, but will have no effect when `commentId` is used.
191 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Comments only support paging options. `per_page` and `page`.
192
193 **Example usage:**
194 ```javascript
195 // Get all comments for a shot
196 $.jribbble.shots(2067969).comments().then(function(res) {
197 // Do cool stuff with response
198 });
199 ```
200
9383247 @tylergaw more docs
authored May 25, 2015
201 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/LVZrBq/?editors=101).
348fe3a @tylergaw First examples for comments
authored May 19, 2015
202
203 ```javascript
204 // Get a single comment for a shot
205 $.jribbble.shots(2067969).comments(4448286).then(function(res) {
206 // Do cool stuff with response
207 });
208 ```
209
9383247 @tylergaw more docs
authored May 25, 2015
210 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/yNJERz/?editors=101).
348fe3a @tylergaw First examples for comments
authored May 19, 2015
211
f74da70 @tylergaw Adding likes for a comment, still need example
authored May 19, 2015
212 #### `$.jribbble.shots(shotId).comments(commentId).likes(options)`
213
214 **Description:** Gets the likes for a comment.
215
216 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
217 - shotId - *required* `String or Int`
f74da70 @tylergaw Adding likes for a comment, still need example
authored May 19, 2015
218 - commentId - *required* `String or Int` The id of the comment
219 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Likes only support paging options. `per_page` and `page`.
220
221 **Example usage:**
222 ```javascript
223 // Get the likes for a comment.
224 $.jribbble.shots(2069352).comments(4450321).likes().then(function(res) {
225 // Do cool stuff with response
226 });
227 ```
228
9383247 @tylergaw more docs
authored May 25, 2015
229 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/LVZwQL/?editors=101).
5347ea8 @tylergaw Adding comment.likes example link
authored May 19, 2015
230
93aefbe @tylergaw likes docs
authored May 25, 2015
231 #### `$.jribbble.shots(shotId).likes(options)`
232
233 **Description:** Gets the likes for a shot.
234
235 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
236 - shotId - *required* `String or Int`
93aefbe @tylergaw likes docs
authored May 25, 2015
237 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Likes only support paging options. `per_page` and `page`.
238
239 **Example usage:**
240 ```javascript
1f65b7f @tylergaw buckets docs
authored May 26, 2015
241 // Get the likes for a shot.
93aefbe @tylergaw likes docs
authored May 25, 2015
242 $.jribbble.shots(2058881).likes().then(function(res) {
243 // Do cool stuff with response
244 });
245 ```
246
247 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/jPVVZb/?editors=101).
248
84d7ccc @tylergaw Projects example
authored May 25, 2015
249 #### `$.jribbble.shots(shotId).projects(options)`
250
251 **Description:** Gets the projects for a shot.
252
253 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
254 - shotId - *required* `String or Int`
84d7ccc @tylergaw Projects example
authored May 25, 2015
255 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Projects only support paging options. `per_page` and `page`.
256
257 **Example usage:**
258 ```javascript
1f65b7f @tylergaw buckets docs
authored May 26, 2015
259 // Get the projects for a shot.
84d7ccc @tylergaw Projects example
authored May 25, 2015
260 $.jribbble.shots(2077496).projects().then(function(res) {
261 // Do cool stuff with response
262 });
263 ```
264
265 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/qdqqYo/?editors=101).
266
ae8bd10 @tylergaw rebounds docs
authored May 26, 2015
267 #### `$.jribbble.shots(shotId).rebounds(options)`
268
269 **Description:** Gets the rebounds for a shot.
270
271 **Parameters:**
4786b86 @tylergaw So much more documentation
authored May 26, 2015
272 - shotId - *required* `String or Int`
ae8bd10 @tylergaw rebounds docs
authored May 26, 2015
273 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Rebounds only support paging options. `per_page` and `page`.
274
275 **Example usage:**
276 ```javascript
1f65b7f @tylergaw buckets docs
authored May 26, 2015
277 // Get the rebounds for a shot.
ae8bd10 @tylergaw rebounds docs
authored May 26, 2015
278 $.jribbble.shots(2046896).rebounds().then(function(res) {
279 // Do cool stuff with response
280 });
281 ```
282
283 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/XbNpqx/?editors=101).
284
4786b86 @tylergaw So much more documentation
authored May 26, 2015
285 ### Users
286
310ff01 @tylergaw Users examples
authored May 26, 2015
287 #### `$.jribbble.users(userId)`
288
289 **Description:** Gets a single user
290
291 **Parameters:**
292 - userId - *required* `String or Int` The username or id for the user.
293
294 **Example usage:**
295 ```javascript
296 $.jribbble.users('tylergaw').then(function(res) {
297 // Do cool stuff with response
298 });
299 ```
300
301 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/bdBrYK/?editors=101).
302
6e47b7e @tylergaw Missed a few shots examples
authored Jun 4, 2015
303 #### `$.jribbble.users(userId).shots(options)`
304
305 **Description:** Get a user's shots
306
307 **Parameters:**
308 - userId - *required* `String or Int` The username or id for the user.
309 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. User's shots only support paging options. `per_page` and `page`.
310
311 **Example usage:**
312 ```javascript
313 $.jribbble.users('tylergaw').shots().then(function(res) {
314 // Do cool stuff with response
315 });
316 ```
317
318 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/NqpzvE/?editors=101).
319
310ff01 @tylergaw Users examples
authored May 26, 2015
320 #### `$.jribbble.users(userId).buckets(options)`
321
322 **Description:** Gets a user's buckets
323
324 **Parameters:**
325 - userId - *required* `String or Int` The username or id for the user.
326 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Buckets only support paging options. `per_page` and `page`.
327
328 **Example usage:**
329 ```javascript
6e47b7e @tylergaw Missed a few shots examples
authored Jun 4, 2015
330 $.jribbble.users('markbult').buckets().then(function(res) {
310ff01 @tylergaw Users examples
authored May 26, 2015
331 // Do cool stuff with response
332 });
333 ```
334
335 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/bdBrXz/?editors=101).
336
6e47b7e @tylergaw Missed a few shots examples
authored Jun 4, 2015
337 #### `$.jribbble.users(userId).projects(options)`
338
339 **Description:** Gets a user's projects
340
341 **Parameters:**
342 - userId - *required* `String or Int` The username or id for the user.
343 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. User projects only support paging options. `per_page` and `page`.
344
345 **Example usage:**
346 ```javascript
347 $.jribbble.users('creativemints').projects().then(function(res) {
348 // Do cool stuff with response
349 });
350 ```
351
352 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/xGqzjR/?editors=101).
353
354 #### `$.jribbble.users(userId).teams(options)`
355
356 **Description:** Gets the teams a user belongs to
357
358 **Parameters:**
359 - userId - *required* `String or Int` The username or id for the user.
360 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. User teams only support paging options. `per_page` and `page`.
361
362 **Example usage:**
363 ```javascript
364 $.jribbble.users('veerlepieters').teams().then(function(res) {
365 // Do cool stuff with response
366 });
367 ```
368
369 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/RPpJJQ/?editors=101).
370
371 #### `$.jribbble.users(userId).likes(options)`
372
373 **Description:** Gets the shots a user likes
374
375 **Parameters:**
376 - userId - *required* `String or Int` The username or id for the user.
377 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. User likes only support paging options. `per_page` and `page`.
378
379 **Example usage:**
380 ```javascript
381 $.jribbble.users('op45').likes().then(function(res) {
382 // Do cool stuff with response
383 });
384 ```
385
386 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/WvpyKm/?editors=101).
387
310ff01 @tylergaw Users examples
authored May 26, 2015
388 #### `$.jribbble.users(userId).followers(options)`
389
390 **Description:** Gets a user's followers
391
392 **Parameters:**
393 - userId - *required* `String or Int` The username or id for the user.
394 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Followers only support paging options. `per_page` and `page`.
395
396 **Example usage:**
397 ```javascript
398 $.jribbble.users('tylergaw').followers().then(function(res) {
399 // Do cool stuff with response
400 });
401 ```
402
403 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/ZGBJdY/?editors=101).
404
405 #### `$.jribbble.users(userId).following(options)`
406
407 **Description:** Gets the users a user is following
408
409 **Parameters:**
410 - userId - *required* `String or Int` The username or id for the user.
411 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Following only support paging options. `per_page` and `page`.
412
413 **Example usage:**
414 ```javascript
415 $.jribbble.users('tylergaw').following().then(function(res) {
416 // Do cool stuff with response
417 });
418 ```
419
420 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/jPVLdR/?editors=101).
421
422 #### `$.jribbble.users(userId).isFollowing(targetUserId)`
423
424 **Description:** Check to see if a user is following another user.
425
426 **Parameters:**
427 - userId - *required* `String or Int` The username or id for the user.
428 - targetUserId - *required* `String or Int` The username or id for the other user.
429
430 **Example usage:**
431 ```javascript
432 $.jribbble.users('tylergaw').isFollowing('jimniels').then(function(res) {
433 // Do cool stuff with response
434 });
435 ```
436
437 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/bdBrjx/?editors=101).
1f65b7f @tylergaw buckets docs
authored May 26, 2015
438
4786b86 @tylergaw So much more documentation
authored May 26, 2015
439 ### Teams
440
d912579 @tylergaw Teams examples
authored May 26, 2015
441 #### `$.jribbble.teams(teamId).members(options)`
442
443 **Description:** Gets the members of a team.
444
445 **Parameters:**
446 - teamId - *required* `String`
447 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Teams only support paging options. `per_page` and `page`.
448
449 **Example usage:**
450 ```javascript
451 $.jribbble.teams('eight2eight').members(options).then(function(res) {
452 // Do cool stuff with response
453 });
454 ```
455
456 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/bdBrgv/?editors=101).
457
458 #### `$.jribbble.teams(teamId).shots(options)`
459
460 **Description:** Gets the shots for a team.
461
462 **Parameters:**
463 - teamId - *required* `String`
464 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Shots only support paging options. `per_page` and `page`.
465
466 **Example usage:**
467 ```javascript
468 $.jribbble.teams('eight2eight').shots(options).then(function(res) {
469 // Do cool stuff with response
470 });
471 ```
472
473 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/bdBrWM/?editors=101).
1f65b7f @tylergaw buckets docs
authored May 26, 2015
474
4786b86 @tylergaw So much more documentation
authored May 26, 2015
475 ### Buckets
476
1f65b7f @tylergaw buckets docs
authored May 26, 2015
477 #### `$.jribbble.buckets(bucketId)`
478
479 **Description:** Gets a single bucket
480
481 **Parameters:**
482 - bucketId - *required* `String or Int`
483
484 **Example usage:**
485 ```javascript
486 $.jribbble.buckets(114550).then(function(res) {
487 // Do cool stuff with response
488 });
489 ```
490
491 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/mJORor/?editors=101).
492
493 #### `$.jribbble.buckets(bucketId).shots(options)`
494
495 **Description:** Gets the shots for a project
496
497 **Parameters:**
498 - bucketId - *required* `String or Int`
499 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Shots only support paging options. `per_page` and `page`.
500
501 **Example usage:**
502 ```javascript
503 // Get the shots for a bucket.
504 $.jribbble.buckets(114550).shots(options).then(function(res) {
505 // Do cool stuff with response
506 });
507 ```
508
509 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/ZGBLPq/?editors=101).
510
4786b86 @tylergaw So much more documentation
authored May 26, 2015
511 ### Projects
512
513 #### `$.jribbble.projects(projectId)`
514
515 **Description:** Gets a single project
516
517 **Parameters:**
518 - projectId - *required* `String or Int`
519
520 **Example usage:**
521 ```javascript
522 $.jribbble.projects(267945).then(function(res) {
523 // Do cool stuff with response
524 });
525 ```
526
527 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/MwbJPB/?editors=101).
528
529 #### `$.jribbble.projects(projectId).shots(options)`
530
531 **Description:** Gets the shots for a project
532
533 **Parameters:**
534 - projectId - *required* `String or Int`
535 - options - *optional* `Object` Key:value pairs of options that will be included in the request as query parameters. Shots only support paging options. `per_page` and `page`.
536
537 **Example usage:**
538 ```javascript
1f65b7f @tylergaw buckets docs
authored May 26, 2015
539 // Get the shots for a project.
4786b86 @tylergaw So much more documentation
authored May 26, 2015
540 $.jribbble.projects(267945).shots(options).then(function(res) {
541 // Do cool stuff with response
542 });
543 ```
544
545 Live example [on Codepen.io](http://codepen.io/tylergaw/pen/mJORaE/?editors=101).
546
f74da70 @tylergaw Adding likes for a comment, still need example
authored May 19, 2015
547 ---------------------------------------------------------------------------
548
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
549 ## Contributing
550 Jribbble is open source. [Issues](https://github.com/tylergaw/jribbble/issues) and [pull requests](https://github.com/tylergaw/jribbble/pulls) gladly accepted.
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
551
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
552 ### Tests
553 Jribbble uses Qunit and PhantomJS for tests. If you submit a pull request, you should most likely write a new test or modify an existing test. All tests must pass for a pull request to be accepted.
e5a4453 @tylergaw Adding a tutorials section
authored Sep 6, 2014
554
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
555 Installing test dependencies:
556 ```
557 npm install && npm install -g node-qunit-phantomjs
558 ```
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
559
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
560 running the tests:
561 ```
562 make test
563 ```
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
564
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
565 The tests will also run when pull requests are submitted. See [Travis](https://travis-ci.org/tylergaw/jribbble) for build status.
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
566
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
567 ### Building Jribbble
dabf227 @tylergaw Version bump, minify fix
authored May 26, 2015
568 Jribbble includes a small Makefile that includes a build task. The task copies the jribbble.js source to the `/dist` directory–adding the version number and build date–and creates a minified version of it using UglifyJS2.
569
570 To build Jribbble you'll need UglifyJS2:
571
572 ```
573 npm install uglify-js -g
574 ```
575
576 then run
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
577
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
578 ```
579 make
580 ```
e409f21 @acreek Fixed an issue with formatting of document.
acreek authored Dec 16, 2011
581
2f1e53a @tylergaw Working on the readme
authored May 18, 2015
582 from the root directory
Something went wrong with that request. Please try again.