update changelog and readme

gutjuri · gutjuri · commit 975813e91b53 · 2020-10-14T11:16:11.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # 0.8.1
 
 * When pages are updated, the client now shows the download location.
+* Add optional auto-update functionality (`--auto-update-interval`)
 
 # 0.8.0
 
diff --git a/README.md b/README.md
@@ -38,14 +38,17 @@ Available options:
   -L,--language LOCALE     Preferred language for the page returned
   COMMAND                  name of the command
   -a,--about               About this program
+  --auto-update-interval DAYS
+                           Perform an automatic update if the cache is older
+                           than DAYS
 ```
 
 Or a much better example of the usage:
 
 ``` shellsession
 $ tldr tldr
 tldr
-Simplified man pages.More information: https://tldr.sh.
+Simplified man pages. More information: https://tldr.sh.
 
  - Get typical usages of a command (hint: this is how you got here!):
    tldr {{command}}
@@ -57,6 +60,13 @@ Simplified man pages.More information: https://tldr.sh.
    tldr {{git checkout}}
 ```
 
+On the first run, this programme caches all available tldr pages. 
+Since the number of available tldr pages rises quickly, it is recommended to regularly update the cache. 
+Such an update can be run manually with `tldr --update`. 
+Users of this client can enable automatic updates by running it with the option `--auto-update-interval DAYS` specified.
+The client will then check whether the cached version of the tldr pages is older than `DAYS` days and perform an update in that case.
+To enable this functionality permanemtly, users can put the line `alias tldr="tldr --auto-update-interval DAYS"` in their shell configuration file (e.g. `.bashrc`, `.zshrc`) with the desired update interval specified.
+
 ## Snapshot
 
 ![tldr](https://cloud.githubusercontent.com/assets/737477/24076451/2a5a604c-0c57-11e7-9bf7-13d76e8e7f12.png)

-Original file line number
+Diff line change
@@ @@ -1,6 +1,7 @@ @@
 # 0.8.1
 * When pages are updated, the client now shows the download location.
 +* Add optional auto-update functionality (`--auto-update-interval`)
 # 0.8.0