Skip to content

Commit

Permalink
Update readme, add license
Browse files Browse the repository at this point in the history
  • Loading branch information
loopj committed Feb 22, 2013
1 parent f6b95a7 commit 19e1948
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 3 deletions.
19 changes: 19 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,19 @@
Copyright (c) 2013 Bugsnag, https://bugsnag.com/

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
48 changes: 45 additions & 3 deletions README.md
@@ -1,18 +1,22 @@
Add Jobs to Sidekiq from Node.js
================================

Enqueue jobs to sidekiq from your node apps. Closely mirrors the official
ruby sidekiq interface.


Installation
------------

```bash
```shell
npm install sidekiq --save
```


Usage
-----

```coffee
```javascript
// Require the module
Sidekiq = require("sidekiq");

Expand All @@ -24,4 +28,42 @@ sidekiq.enqueue("WorkerClass", ["argument", "array"], {
retry: false,
queue: "critical"
});
```
```


How to Build
------------

```shell
# Install development dependencies
npm install

# Use grunt to generate the js version (lib/index.js)
grunt
```


Reporting Bugs or Feature Requests
----------------------------------

Please report any bugs or feature requests on the github issues page for this
project here:

<https://github.com/loopj/sidekiq/issues>


Contributing
------------

- [Fork](https://help.github.com/articles/fork-a-repo) the [notifier on github](https://github.com/loopj/sidekiq)
- Edit only the files in `src` **NOT `lib`**, lib files are autogenerated
- Commit and push until you are happy with your contribution
- [Make a pull request](https://help.github.com/articles/using-pull-requests)
- Thanks!


License
-------

The Bugsnag JavaScript notifier is free software released under the MIT License.
See [LICENSE.txt](https://github.com/loopj/sidekiq/blob/master/LICENSE.txt) for details.

0 comments on commit 19e1948

Please sign in to comment.