Skip to content

Commit d2dd421

Browse files
committed
read me
1 parent 97de8a5 commit d2dd421

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you are using a different authentication system that does not have a current_
3030

3131
### Ruby and Rails
3232

33-
Starburst requires Rails 3.1 or greater.
33+
Starburst [works](https://secure.travis-ci.org/csm123/starburst.svg?branch=master)] on Rails 3 and 4, and Ruby 1 and 2.
3434

3535
## Installation
3636

@@ -90,6 +90,7 @@ Find out more about [scheduling announcements](#scheduling) and [targeting them
9090
You can schedule annoucements as follows:
9191

9292
`start_delivering_at` - Do not deliver this announcement until this date.
93+
9394
`stop_delivering_at` - Do not show this announcement to anyone after this date, not even to users who have seen the message before but not acknowledged it.
9495

9596
Announcement.create(:start_delivering_at => Date.today, :stop_delivering_at => Date.today + 10.days)
@@ -117,7 +118,7 @@ The code below targets the announcement to users with a `subscription` field equ
117118
Most Rails authentication libraries (like Devise and Clearance) place the current user into the `current_user` method. If your authenticaiton library uses a different method, create an initializer for Starburst at `config/initializers/starburst.rb` and add the text below, replacing `current_user` with the name of the equivalent method in your authentication library.
118119

119120
Starburst.configuration do |config|
120-
config.current_user_method = "current_user"
121+
config.current_user_method = "current_user"
121122
end
122123

123124
### Targeting by methods rather than fields
@@ -136,11 +137,13 @@ You can target based on methods that are not in the database, but you must speci
136137

137138
## Roadmap
138139

139-
* Installation script to reduce steps
140-
* Administrative interface for adding and editing announcements
141-
* Target annoucements with operators other than `=` (ex. users created after a certain date)
142-
* Easy way to get an archive of messages for a particular user
143-
* Convenience methods to see which messages a particular user has and hasn't read
144-
* Stats on how many messages are unread, read, and dismissed
140+
* Installation
141+
** Installation script to reduce steps
142+
* Admin
143+
** Administrative interface for adding and editing announcements
144+
** Target annoucements with operators other than `=` (ex. users created after a certain date)
145+
** Stats on how many messages are unread, read, and dismissed
146+
* User
147+
** Archive of messages delivered to a particular user
145148

146149
Please add suggestions to the Issues tab in GitHub.

0 commit comments

Comments
 (0)