You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ If you are using a different authentication system that does not have a current_
30
30
31
31
### Ruby and Rails
32
32
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.
34
34
35
35
## Installation
36
36
@@ -90,6 +90,7 @@ Find out more about [scheduling announcements](#scheduling) and [targeting them
90
90
You can schedule annoucements as follows:
91
91
92
92
`start_delivering_at` - Do not deliver this announcement until this date.
93
+
93
94
`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.
@@ -117,7 +118,7 @@ The code below targets the announcement to users with a `subscription` field equ
117
118
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.
118
119
119
120
Starburst.configuration do |config|
120
-
config.current_user_method = "current_user"
121
+
config.current_user_method = "current_user"
121
122
end
122
123
123
124
### 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
136
137
137
138
## Roadmap
138
139
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
145
148
146
149
Please add suggestions to the Issues tab in GitHub.
0 commit comments