spin_loader 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 022f225b16c1eb0328b1da77158038ebc5044e9d
-  data.tar.gz: 7a8a2e6be9ca5a5173cd707acbcd41000d17ffb7
+  metadata.gz: b43b7b043e789cc8ab3e8c671c24a9c40b0c4c34
+  data.tar.gz: 608db5a1c5c8f6a0345ba2b0ca39e024e952e523
 SHA512:
-  metadata.gz: df579de0ef123a8169b7a4875de497d58637c130e9dd0cadf945ca2c29d37b96eaa21a3c08dc2282e7d6a2e39ff07daf4c4cf0eaf2ccf68292d0b1e0c350a93f
-  data.tar.gz: 50c0ea03eac03549e7524b704ac89143cf1518da0900a6d5ed305dad67d5630dc1f0ac61b0fb83296fbca64a8b54fc813f8d17fa7418e4187a6cce893b522784
+  metadata.gz: 0195fb8b10e17dfd7afc3434b8f9624b8dde291ad52d84a003404548a65698fd87f3ec730f4c06d6a52f79ce6614c611c355be23775b64f000c7a16030ab6dfc
+  data.tar.gz: 30ba9de728a003004ccccc4d852a54205d7471eb54ac79d758db60456bc862bb98f6ca713ae5a4118c0b2e43022c1f280a1cbbaac750cd9afe9dfb80cf634d5f

data/README.md

@@ -1,12 +1,14 @@
-# SpinLoader
+# Spin Loader
 
-TODO: Write a gem description
+This is a Gem based on [Spin.js](http://fgnass.github.io/spin.js/) to create a big semi-transparent full screen loader with a spinner in the center.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'spin_loader'
+```ruby
+gem 'spin_loader'
+```
 
 And then execute:
 
@@ -18,11 +20,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Importing the files
+
+In your app/assets/javascripts/application.js file, add the following line:
+
+```javascript
+//= require spin_loader
+```
+
+In your app/assets/stylesheets/application.css file, add the following line:
+
+```css
+ *= require spin_loader
+```
+
+### Start and Stop the loader
+
+In your coffeescript files, add the following:
+
+```coffeescript
+root = exports ? this
+```
+
+Now, you have 2 commands, one to start the loader e other to stop the loader.
+
+```coffeescript
+// This starts the loader
+root.start_loading()
+
+//This stops the loader
+root.stop_loading()
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/spin_loader/fork )
+1. Fork it ( http://github.com/arielschvartz/spin_loader/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/spin_loader/version.rb

@@ -1,3 +1,3 @@
 module SpinLoader
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spin_loader.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_dependency 'coffee-rails'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spin_loader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ariel Schvartz
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Creates a full screen loader with a background mask based on spin.js
   library. Creates coffeescript helpers.
 email: