announcements 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,7 @@
+# announcements
+
+The Announcements gem provides an easy way to publish short messages in your views, which the user can then hide permanently. It is influenced by the gem `paul_revere` by thoughtbot, but is
+much much simpler - no partials used, 'type' attribute for different types of announcements, and others.
 
 ## Quick start
 
@@ -10,10 +14,53 @@
 
 ## Styling
 
+By default, the announcement text and hide message text are wrapped in a div called "info" (if you want to customise that, see the Customisation section below).
+You can use the following css in your application.css file to start:
+
+```css
+.info {
+	background: #D5EDF8;
+	color: #205791;
+	padding: 0.8em;
+	margin-bottom: 1em;
+	border: 2px solid #92CAE4;
+}
+
+.hide_announcement {
+	cursor: pointer;
+	float: right;
+}
+```
+
 ## Customisation
 
+The default HTML output of the `announce` helper is
+
+```html
+<div class="info">
+	My announcement!
+	<span class="hide_announcement" data-announcementid="1">hide message</span>
+</div>
+```
+
+The default div class is `info`. You can specify you own like that:
+
+```ruby
+<%= announce Announcement.newest, :div_class => "mydiv" %>
+```
+
+You can also change the "hide message" text:
+
+```ruby
+<%= announce Announcement.newest, :div_class => "mydiv", :hide_message => "X" %>
+```
+
 ## How it works
 
+The gem creates an Announcement model with a few class methods like `Announcement.newest`. The Announcement model has a body:text (the actual announcement text) 
+and a type:string (which you can use for different types of announcements, e.g. public (everyone) and private (only for registered users)). There is also a js file in vendor/assets/javascripts
+which permanently hides the announcement by creating a cookie (that's when you click on the 'hide message' text).
+
 ## How to uninstall
 
 There is no uninstaller at this point, but you can simply remove the following files manually:

data/announcements.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Svilen Gospodinov"]
   s.email       = ["svilen@gospodinov.co.uk"]
   s.homepage    = ""
-  s.summary     = "Announcements for Rails >= 3.1.0"
+  s.summary     = "Announcements gem for Rails"
   s.description = "The Announcements gem makes it easier to display short announcement messages in your views"
 
   s.rubyforge_project = "announcements"
@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  s.add_runtime_dependency "jquery-rails"
-  s.add_runtime_dependency "rails", ">= 3.1.0"
+  s.add_runtime_dependency "rails", "~> 3.1"
+
 end

data/lib/announcements/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: announcements
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,28 +11,17 @@ bindir: bin
 cert_chain: []
 date: 2012-01-22 00:00:00.000000000Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: &26346180 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *26346180
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &26345736 !ruby/object:Gem::Requirement
+  requirement: &25371696 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *26345736
+  version_requirements: *25371696
 description: The Announcements gem makes it easier to display short announcement messages
   in your views
 email:
@@ -76,5 +65,5 @@ rubyforge_project: announcements
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Announcements for Rails >= 3.1.0
+summary: Announcements gem for Rails
 test_files: []