README.md in hard_worker-0.0.3 vs README.md in hard_worker-0.0.4
- old
+ new
@@ -1,16 +1,20 @@
# Hardworker
+[](https://www.codefactor.io/repository/github/sampokuokkanen/hard_worker) [](https://badge.fury.io/rb/hard_worker)
+
This is HardWorker, a new Ruby backend job library! It supports running procs and classes in the background.
~~Also, you lose all jobs if you restart the process.~~ It now uses YAML to load the queue into a file, which it then calls at startup to find the previous jobs.
It uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries.
TODO LIST:
- ~~Marshal the job queue into a file so you don't lose all progress~~
(Ended up using YAML)
-- Support Rails and ActiveJob
+- ~~Support Rails~~ (Supported!)
+- ~~Parse options from command line, eg. `--workers 10`~~(Done!)
+- Maybe support ActiveJob?
- Have a web UI
- Do some performance testing
- Add a section telling people to use Sidekiq if they can
## Installation
@@ -60,10 +64,53 @@
dummy = DummyWorker.new
dummy.queue.push(proc { 2 / 1 })
dummy.queue.push(DumDum.new)
```
+Hardworker runs on localhost, port 8788. Should probably make that a value you can change...
+## Rails
+
+Usage with Rails:
+First, start up HardWorker.
+Then,
+```ruby
+$client = HardWorker::Client.new
+```
+
+and you can use the client!
+Call
+
+```ruby
+$client.perform_belated(job)
+```
+If you want to pass a job to HardWorker.
+
+# Settings
+Configuring HardWorker:
+
+```ruby
+HardWorker.configure do |config|
+ config.rails = false # default is true
+ config.rails_path = # './dummy' default is '.'
+ config.connect = false # Connect to dRuby, default is true, useful for testing only
+ config.workers = 2 # default is 1
+end
+```
+
+From command line:
+
+$ bundle exec hard_worker --rails=true
+
+Use Rails or not.
+
+$ bundle exec hard_worker --rails_path=/my_rails_project
+
+Path to Rails project.
+
+$ bundle exec hard_worker --workers=10
+
+Number of workers.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).