aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2016-02-17 14:42:54 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2016-02-17 14:42:54 +0100
commitcaaceba9c4fa4c33843760256c4e147d8f01ae5a (patch)
tree80f4f17d206e4881b4c5ee73c01d562481ec7501 /README.md
parent90d22cc1df98ebae414dfc40136349a8aa651956 (diff)
downloadmark-caaceba9c4fa4c33843760256c4e147d8f01ae5a.tar.gz
mark-caaceba9c4fa4c33843760256c4e147d8f01ae5a.zip
improve README
+ add requirements + document that there is no "easy" usage yet
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 86b2793..4303625 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,17 @@
mark is a little fish-shell script to mark days and get statistics about your marks.
+## Requirements
+
++ fish-shell
++ cal
++ date
++ cat
+
## Usage
+At the current state you have to use all mark functions on there own.
+
## License
[MIT][mit] © [fischerling][author] et [al][contributors]