Skip to content

Commit

Permalink
improve doc a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
s-soroosh committed Feb 6, 2017
1 parent eddfa1c commit 48233f3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/index.md
@@ -1,6 +1,6 @@
Easy-Job
========
Easy-Job is asynchronous task runner for django , it means you can run a function without waiting for the function to finish .
Easy-Job is asynchronous task runner for django , it means you can run a function without waiting for the function to finish.

*Notice : current design of easy-job depends on django framework but in the near future we intend to break this dependency*

Expand Down Expand Up @@ -52,7 +52,7 @@ three simple steps are required to make setup easy-job in your django project :
}
}

let me explain what these configurations are from top :
Configuration explanation:

- key of dictionary : worker name is a custom name which you specify for the worker , later you will use this name to send tasks to this particular worker.
- initializer: the dot.path to worker initializer class, you can use one of : `easy_job.workers.rabbitmq.RabbitMQInitializer`
Expand Down Expand Up @@ -99,7 +99,7 @@ easy_job.init()
```
this little code will initialize easy-job and create all your workers .

####3.run your tasks
####3. run your tasks

somewhere in your project you can run your tasks:

Expand All @@ -112,7 +112,7 @@ runner.run(
kwargs={'named':'parameters'}
)
```
that's it
and that's it
##Some more options :

####Specifying retry policy when running tasks :
Expand Down

0 comments on commit 48233f3

Please sign in to comment.