summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-07-12 17:00:02 +0200
committerMatthias Beyer <mail@beyermatthias.de>2016-07-12 17:00:02 +0200
commit51432eaf39236ec3741c2654a552d220fd626fdd (patch)
treec82df644045a407863c11b86bd7f22f731bffeea /doc
parent1bf7d16664372194be240b0d93c244750cf4c291 (diff)
Add example how to use imag-counter
Diffstat (limited to 'doc')
-rw-r--r--doc/src/04020-module-counter.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/src/04020-module-counter.md b/doc/src/04020-module-counter.md
index 6ead3f8c..ad09531d 100644
--- a/doc/src/04020-module-counter.md
+++ b/doc/src/04020-module-counter.md
@@ -15,6 +15,17 @@ possibly timestamp of your increments/decrements, so you can export this and use
Filters for selecting only certain time ranges when listing/exporting your
counters will be added as well.
+### Examples
+
+Here are some examples how to use the counter module:
+
+```bash
+imag counter create --name example --initval 42 # or: -n example -i 42
+imag counter --inc example # or -i example
+imag counter --reset example
+imag counter --dec example # or -d example
+```
+
### Backends
<!-- Backends the module supports including links to external resources -->