pixlee 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.md +16 -2
  2. data/lib/pixlee/version.rb +1 -1
  3. metadata +1 -1
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Pixlee
2
2
 
3
- TODO: Write a gem description
3
+ This gem is a simple API wrapper for Pixlee's API. It allows you to pull your albums, specific images from an album, or search for users albums.
4
4
 
5
5
  ## Installation
6
6
 
@@ -18,7 +18,21 @@ Or install it yourself as:
18
18
 
19
19
  ## Usage
20
20
 
21
- TODO: Write usage instructions here
21
+
22
+ pixlee = Pixlee::API.new(<pixlee_api_key>, <pixlee_app_name>)
23
+
24
+ # Getting your albums
25
+ albums = pixlee.get_albums
26
+
27
+ # Getting all photos in an album
28
+ photos = pixlee.get_album_contents(<album_id>, :type => "all", :sort => "recent|popularity")
29
+
30
+ # Getting a specific photos data
31
+ photo = pixlee.get_album_photo(<album_id>, <album_photo_id>, :type => "public|private")
32
+
33
+ # Getting a users albums
34
+ albums = pixlee.get_users_albums(<user_id>)
35
+
22
36
 
23
37
  ## Contributing
24
38
 
@@ -1,3 +1,3 @@
1
1
  module Pixlee
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pixlee
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: