README.md in jackie-0.0.2 vs README.md in jackie-0.0.3
- old
+ new
@@ -1,5 +1,7 @@
+[](https://travis-ci.org/firebaseco/jackie)
+
# Jackie
A Ruby interface to the Kickfolio API.
## Installation
@@ -23,41 +25,56 @@
# Set your Api Key
Jackie.api_key = "MyKickfolioApiKey"
```
### Basic Objects Operations
```ruby
-# Create New app
-app = Jackie::App.new(app_attributes)
+# Create a new app
+app = Jackie::App.new(:name => "Hello")
app.save
-# Find the app with app_id 1.
+# Find the app with id 1.
app = Jackie::App.find(1)
-app.name = "new name"
+app.name = "HelloWorld"
app.save
-# GET the App versions
-app.versions
-
-# Delete a App
+# Delete an App
app.destroy
-# GET the Apps
+# Get all the existing Apps
Jackie::App.all
-# Create New App Version
-version = Jackie::Version.new(:app_id => app.id, :bundle_url => "https://bundle_url.com/myiosapp")
+# Create a new Version of an App
+version = Jackie::Version.new(:app_id => app.id, :bundle_url => "https://site.org/hello.app.zip")
version.save
-# Find the version with version id 1.
+# Find the version with id 1.
version = Jackie::Version.find(1)
-# GET All Versions
+# Get all the Versions
Jackie::Version.all
+# GET all the Versions of an App
+app.versions
+
# Delete a Version
version.destroy
```
+### Jackie and AWS-S3
+The following is optional. You can use Jackie without S3 as seem above.
+```ruby
+# Set your AWS api keys
+Jackie.configure_s3({
+ :access_key_id => "YOUR ACCESS KEY ID",
+ :secret_access_key => "YOUR SECRET ACCESS KEY"
+}, {:bucket => "YOUR BUCKET"})
+
+# Usage
+version = Jackie::Version.new(:app_id => app.id, :file => "path/to/local/file.zip")
+version.save
+```
+For additional information read the [Kickfolio API docs](https://github.com/Kickfolio/ApiDocs)
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -66,6 +83,6 @@
License
-------
Jackie is Copyright © 2013 Firebase. It is free software,
-and may be redistributed under the terms specified in the MIT-LICENSE file.
+and may be redistributed under the terms specified in the LICENSE.txt file.