README.md in hackpad-cli-0.0.6 vs README.md in hackpad-cli-0.0.7
- old
+ new
@@ -13,12 +13,17 @@
It uses Hackpad REST API 1.0 https://hackpad.com/fQD2DRz22Wf and was tested with ruby 1.9.3 and 2.1.1.
Initially this tool was created to overcome the frustration of the md export of pads,
because we need to copy them to other places sometimes. Proper markdown would be appreciated. It does that by transforming the html in markdown with the https://github.com/xijo/reverse_markdown gem.
-Then it felt right to cache the pads content and list because then we can browse and search in the whole workspace very fast. So by default the `list`, `show` and `info` are cached unless you pass the `-r` option at the end of the commandline. Note that the longest is the `list` because the API don't provide pads titles, so `hpcli list` actually downloads the whole list of the pads in txt format. But it makes the `info` and the `show` very fast after that.
+Offline hackpad reading
+-----------------------
+It felt right to cache the pads content and list because then we can browse and search in the whole workspace very fast. So by default the `list`, `show` and `info` are cached unless you pass the `-r` option at the end of the commandline. Note that the longest is the `list` because the API don't provide pads titles, so `hpcli list` actually downloads the whole list of the pads in txt format. But it makes the `info` and the `show` very fast after that.
+
+The side effect is that it provides the ability to just refresh the list of pads with `hpcli list`, and it will cache the text version of each pad locally. Then you can `hpcli show <xxx>` without hitting the api.
+
Installation
------------------
gem install hackpad-cli
@@ -33,10 +38,11 @@
(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.
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.
hpcli search [term] # Lists available pads matching [term].
hpcli show [pad_id] [format] # shows pad <pad_id> in format [html,txt,md] (default txt).
@@ -62,10 +68,10 @@
- for v0.1.0
- <s>add freaking cool badges on the readme</s>
- <s>cache the pads list in a local storage</s>
- <s>have a choice to refresh cache</s>
- - display cached date in output
+ - <s>display cached date in output</s>
- write proper tests
- for v0.2.0
- 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