summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOlivier Gayot <duskcoder@gmail.com>2014-11-07 20:47:17 +0000
committerOlivier Gayot <duskcoder@gmail.com>2014-11-07 20:47:17 +0000
commit4d0101cddb7a05f1e1232bdf6b4bd49036ba96f0 (patch)
tree2389d19d045601d3c426562a38f203932783cd40 /README.md
parent42af04afef430e1af2714988e258556d06914acd (diff)
update the README (show examples and usage)
Signed-off-by: Olivier Gayot <duskcoder@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index b07bf96..6a219ab 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,15 @@ the uid or last name given.
* ldapsearch is needed for the software to run properly. It is
often provided in the package `openldap'
-usage:
+usage
+-----
+
+ $ kent_student_lookup <uid>
+or
+ $ kent_student_lookup <last_name>
+
+examples
+--------
$ kent_student_lookup Gayot