doc/readme: update according to recent changes
2 files changed, 19 insertions(+), 8 deletions(-)

M README.md
M rework/cli.py
M README.md +8 -8
@@ 406,24 406,24 @@ Options:
   --help  Show this message and exit.
 
 Commands:
-  abort-task            immediately abort the given task This will be done...
+  abort-task            immediately abort the given task
   export-scheduled
   import-scheduled
-  init-db               initialize the database schema for rework in its
-                        own...
+  init-db               initialize the database schema for rework in its...
   kill-worker           ask to preemptively kill a given worker to its...
   list-monitors
   list-operations
-  list-scheduled
+  list-scheduled        list the prepared operations with their cron rule
   list-tasks
   list-workers
   log-task
   monitor               start a monitor controlling min/max workers
   new-worker            spawn a new worker -- this is a purely *internal*...
-  register-operations   register operations from a python module containing...
-  shutdown-worker       ask a worker to shut down as soon as it becomes
-                        idle...
-  unregister-operation  unregister an operation (or several) using its name...
+  register-operations   register operations from a python module...
+  scheduled-plan        show what operation will be executed at which...
+  shutdown-worker       ask a worker to shut down as soon as it becomes idle
+  unprepare             remove a scheduling plan given its id
+  unregister-operation  unregister an operation (or several) using its...
   vacuum                delete non-runing workers or finished tasks
 ```
 

          
M rework/cli.py +11 -0
@@ 389,6 389,8 @@ def abort_task(dburi, taskid):
 @rework.command(name='list-scheduled')
 @click.argument('dburi')
 def list_scheduled(dburi):
+    """list the prepared operations with their cron rule
+    """
     init()
     engine = create_engine(find_dburi(dburi))
     sql = (

          
@@ 412,6 414,11 @@ def list_scheduled(dburi):
 @click.argument('dburi')
 @click.argument('sid')
 def unprepare(dburi, sid):
+    """remove a scheduling plan given its id
+
+    To get the schedule plans, use the `list-scheduled` command.
+
+    """
     init()
     engine = create_engine(find_dburi(dburi))
     count = api.unprepare(engine, sid)

          
@@ 427,6 434,10 @@ def unprepare(dburi, sid):
 @click.argument('domain')
 @click.option('--hours', default=1)
 def scheduled_plan(dburi, domain, hours=1):
+    """show what operation will be executed at which time in the next hour
+
+    It is possible to ask for more hours using --hours.
+    """
     engine = create_engine(find_dburi(dburi))
     for stamp, op in schedule_plan(engine, domain, timedelta(hours=hours)):
         print(Fore.GREEN + str(stamp), end=' ')