fix bugs

Author: Yi Zhang

README.md

@@ -33,14 +33,14 @@ Create a TimerThread scheduler and start it:
 ```python
 import timerthread
 
-task = timerthread.Scheduler('recur', 3, now, args=(1,))
-task.start()
+timer = timerthread.Scheduler('recur', 3, now, args=(1,))
+timer.start()
 ```
 
 Shutdown the scheduler:
 
 ```python
-task.cancel()
+timer.cancel()
 ```
 
 
@@ -58,19 +58,77 @@ def now(cost=1):
     time.sleep(cost)
     print( time.strftime('%Y-%m-%d %H:%M:%S %Z', time.localtime()) )
 
-task = now.sched(cost=1)
-task.start()
+timer = now.sched(cost=1)
+timer.start()
 ```
 
 When you'd like to cancel the recurring execution, shutdown the scheduler as usual:
 
 ```python
-task.cancel()
+timer.cancel()
 ```
 
 
 
+### Install TimerThread
+
+```bash
+$ pip install timerthread
+```
+
+
+
+## Documentation
+
+### `Scheduler`
+
+```python
+class timerthread.Scheduler(trigger, interval, fn, args=(), kwargs={})
+```
+
+`trigger` must be `'delay'` or `'recur'`.
+
+* `stopped`
+
+  The scheduler is stopped or not, `True` (default) or `False`.
+
+* `result`
+
+  The execution result, `{}` as default.
+
+* `start()`
+
+  Let scheduler start executing your function as scheduled in the background.
+
+* `cancel()`
+
+  Shutdown the scheduler.
+
+
+
+### `task`
+
+```python
+class timerthread.task(trigger, interval)
+```
+
+`trigger` must be `'delay'` or `'recur'`.
+
+* Use `@task` decorator to define your function, then schedule it and start the scheduler:
+
+  ```python
+  @timerthread.task(trigger, interval)
+  def fn(args, kwargs):
+      pass
+    
+  timer = fn.sched(*args, **kwargs)
+  ```
+
+  `fn.sched(*args, **kwargs)` returns `timerthread.Scheduler` instance.
+
+
+
 ## Related Projects
 
-* [threading.Timer](https://github.com/python/cpython/blob/3.7/Lib/threading.py#L1153) ([Timer Objects](https://docs.python.org/3.7/library/threading.html?highlight=thread#timer-objects))
+* [`threading.Timer`](https://github.com/python/cpython/blob/3.7/Lib/threading.py#L1153) ([Timer Objects](https://docs.python.org/3.7/library/threading.html?highlight=thread#timer-objects))
 

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name='TimerThread',
-    version='0.1.0',
+    version='0.1.1',
     description='A lightweight task scheduling timer',
     author='Yi Zhang',
     author_email='yizhang.dev@gmail.com',
@@ -20,6 +20,7 @@
         'timerthread'
     ],
     keywords=[
+        'timer',
         'background-jobs',
         'background-thread',
         'tasks',

timerthread/scheduler.py

@@ -4,6 +4,7 @@
 TIMEFORMAT = '%Y-%m-%d %H:%M:%S %Z'
 
 import threading
+import time
 
 
 class Scheduler(threading.Thread):