README.md in clockwork_web-0.0.2 vs README.md in clockwork_web-0.0.3
- old
+ new
@@ -1,15 +1,17 @@
# Clockwork Web
-A web interface for [Clockwork](https://github.com/tomykaira/clockwork)
+A web interface for Clockwork
+[View the demo](https://clockwork-web.herokuapp.com/)
+
+[screenshot goes here]
+
- see list of jobs
-- see last run
+- monitor jobs
- disable jobs
-Screenshot, demo, and better UI coming soon
-
## Installation
Add this line to your application’s Gemfile:
```ruby
@@ -22,11 +24,11 @@
mount ClockworkWeb::Engine, at: "clockwork"
```
Be sure to secure the dashboard in production.
-To see the last run and disable jobs, hook up Redis.
+To see the last run and disable jobs, hook up Redis in an initializer.
```ruby
ClockworkWeb.redis = Redis.new
```
@@ -45,20 +47,32 @@
authenticate :user, lambda {|user| user.admin? } do
mount ClockworkWeb::Engine, at: "clockwork"
end
```
+## Monitoring
+
+```ruby
+ClockworkWeb.running?
+ClockworkWeb.multiple?
+```
+
## Customize
Change clock path
```ruby
ClockworkWeb.clock_path = Rails.root.join("clock") # default
```
+Turn off monitoring
+
+```ruby
+ClockworkWeb.monitor = false
+```
+
## TODO
-- demo
- better design
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help: