simple-image-uploader 0.0.8 → 0.0.9

data/README.md

@@ -1,6 +1,6 @@
-# Simple::Image::Uploader
+# simple-image-uploader
 
-TODO: Write a gem description
+simple-image-uploader is a Rails 3 generator that creates a small scaffold class called Image. It enables image upload feature to your web app at no time. 
 
 ## Installation
 
@@ -18,7 +18,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After adding gem 'simple-image-uploader' to your Gemfile.
+
+You should go back to your terminal and type:
+
+    rails g simple_image_uploader
+
+The gem will generate all the files, routes and add the gems needed for image upload.
+
+After, you can run
+
+    rails s
+
+Then you can access the following URL:
+
+    http://localhost:3000/images
+
+Use the Image class to see how you can add the image upload to your existing app.
+
+For example, if you have a Post class where people can upload images for each post, you should add the following code:
+
+In the models/post.rb
+
+    has_many :images
+
+In the models/image.rb
+
+    belongs_to :post
+
+And run
+
+    rails g migration add_post_id_to_images post_id:integer
+
+    rake db:migrate
+
+    rails s
+
+The secret is to link image model to each of your other models that need image upload. For each new link you can either create has_many or has_and_belongs_to relationships.
+
+
 
 ## Contributing
 

data/lib/simple-image-uploader/version.rb

@@ -1,7 +1,7 @@
 module Simple
   module Image
     module Uploader
-      VERSION = "0.0.8"
+      VERSION = "0.0.9"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-image-uploader
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -39,7 +39,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-homepage: ''
+homepage: https://github.com/designium/simple-image-uploader
 licenses: []
 post_install_message: 
 rdoc_options: []