semantic-rails-ui 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 197ef016fd30e9f3e42e554713119ba630d4698a
-  data.tar.gz: a8caa5a8ff0a0a55bf9c2e2d2af5b6449cd5e710
+  metadata.gz: 1ed527fde8e50ef39933b95d93e57bcf57d5537b
+  data.tar.gz: 8aa85e0a817ce4facd48388d0ad39adc8b8e0157
 SHA512:
-  metadata.gz: c16b4cc006f231cb7b914584dad4170f57464f09dd1aab57c362c29de6f23bbef1301ea6803715ecb7c542204c3741e51b764176dd0c795ed9496da48dade406
-  data.tar.gz: 824c32c55f275b0a5cc4df0b705e7fef492f138a557ffe56d600bbe7abe949a33c018d386b5ab3f4a102e1233696775587358d2556b7278e9b71fccd4d0e0f72
+  metadata.gz: 34550655adf62de7bbdd4f7063d18e248eaf28e65afa2330fd647c715c94b5d3428c187af16bc743a9a19ec18951fd54d9477d8fdebcef9764137227bab87b7f
+  data.tar.gz: f314513e88fc01980268044689f9c1cd96345f09a3aaa73be6f4f4f9b88632de4cf3bea8d13daaf3e0701e4bc69273128af3d05892b71cc32c0beac9f62496fa

data/README.md

@@ -13,7 +13,10 @@
 [coveralls]: https://coveralls.io/r/igorj/semantic-rails-ui
 
 
-TODO Description of SemanticRailsUi
+- Integration with semantic-ui (with semantic-ui-sass gem) and simple_form.
+- The gem also includes coffee-rails, sass-rails, jquery-rails, uglifier and turbolinks, so you don't have to include them in your rails application
+- Adds following view helpers: `ui_flash_messages`, `ui_icon`, `ui_icon_header`, `ui_delete_link`
+- Modifies the default rails scaffolding templates so that you get nice semantic-ui scaffolds out of the box
 
 ## Installation
 
@@ -33,7 +36,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO Describe how to use this gem
+Add semantic-rails-ui to your assets: 
+
+application.js
+```
+//= require semantic-rails-ui
+```
+
+application.sass: 
+```
+@import "semantic-rails-ui"
+```
+
+Now you can generate a scaffold and enjoy the semanic-ui look & feel. 
+
+You can also use the provided helpers: 
+
+```
+<%= ui_icon_header "Welcome home", "home" %>
+```
+
+```
+<%= ui_delete_link 'Destroy', article, 'Are you sure?' %>
+```
+
+```
+<%= ui_flash_messages %>
+```
+
 
 ## Development
 

data/app/helpers/semantic_rails_ui/ui_helper.rb

@@ -10,6 +10,8 @@ module SemanticRailsUi
       end
     end
 
+    # supported flash message types: :error, :success, :warning, :info
+    # todo: add support for :alert and :notice
     def ui_flash_messages(options = {})
       merged_options = { id: "messages", class: "messages" }.merge(options)
       content_tag :div, merged_options do
@@ -26,10 +28,12 @@ module SemanticRailsUi
       end
     end
 
+    # renders a semantic-ui icon
     def ui_icon(icon_name)
       content_tag(:i, '', class: "#{icon_name} icon")
     end
 
+    # renders a delete link with semantic-ui confirmation dialog instead of default js confirmation
     def ui_delete_link(button_text, url, message)
       link_to url, class: "ui red tiny compact basic button", method: :delete,
               data: { confirm: message, 'confirm-title' => button_text } do

data/lib/semantic-rails-ui/version.rb

@@ -1,3 +1,3 @@
 module SemanticRailsUi
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic-rails-ui
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Igor Jancev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -250,7 +250,6 @@ files:
 - LICENCE.txt
 - README.md
 - Rakefile
-- app/assets/images/semantic-rails-ui/.keep
 - app/assets/javascripts/semantic-rails-ui.js
 - app/assets/javascripts/semantic-rails-ui/confirm.coffee
 - app/assets/javascripts/semantic-rails-ui/menu.coffee