README.md in hackpad-cli-0.1.0 vs README.md in hackpad-cli-0.1.1

- old
+ new

@@ -40,28 +40,30 @@ (use `bundle exec` if you need, mostly in clone mode when not using rvm) ``` Commands: - hpcli check # Checks differences between local cache and remote list (options: -u to show urls). + hpcli default # change the default workspace. + hpcli getnew # Downloads the new pads the are not cached yet (options: -u to show urls). hpcli help [COMMAND] # Describe available commands or one specific command hpcli info [pad_id] # gets info for the pad <pad_id>. hpcli list # Lists available pads (options: -u to show urls, -r to refresh). hpcli search [term] # Lists available pads matching [term] (options: -u to show urls) - hpcli show [pad_id] [format] # shows pad <pad_id> in format [html,txt,md] (default txt) (options: -r to refresh). + hpcli show [pad_id] [format] # shows pad <pad_id> in format [html,txt,md], default txt (options: -r to refresh). hpcli stats # Lists configuration values. hpcli version # Displays the hackpad-cli version. + hpcli workspaces # Lists configurated hackpad workspaces. Options: -c, [--configdir=CONFIGDIR] # Path to the hackpad-cli directory to use. # Default: /home/mose/.hackpad-cli/ -w, [--workspace=WORKSPACE] # Name of the workspace to use. # Default: default -p, [--plain], [--no-plain] # Add this if you don't want colors. ``` -At first launch it will create your config dir (default ~/.hackpad-cli/), and will ask you questions to create the config file (default is .. default.yml). If you pass the `-w whatever` option at the end, it will ask questions again to write whatever.yml config file. +At first launch it will create your config dir (default ~/.hackpad-cli/), and will ask you questions to create the config file (default is `default/config.yml`). If you pass the `-w whatever` option at the end, it will ask questions again to write `whatever/config.yml` config file. Roadmap and todoz --------------------- @@ -72,9 +74,12 @@ - <s>cache the pads list in a local storage</s> - <s>have a choice to refresh cache</s> - <s>display cached date in output</s> - <s>write proper tests</s> - for v0.2.0 + - clean the markdown generated by reverse_markdown + - add a command for searching on local cache, in titles only or in body + - elaborate a better search syntax so we can have and/or and strings - add commands for creating a new pad, linked to $EDITOR - add a gateway to github so a pad could be copied over a wiki page directly or in a repo somehow - for v0.3.0 - add admin commands for managing users - implement pretty much all what the hackpad API v1 offers