Add some README.

1 files changed, 21 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..460bae0
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+This is tool to query Atlassian Crowd server via command line.
+
+Commands supported:
+
+user, group
+    Query user/group info.
+users, groups
+    Query user/group list. There can be optional query filter parameter
+    using query language as desctibed in
+    https://developer.atlassian.com/display/CROWDDEV/Crowd+Query+Language
+usergroups
+    Query user's groups. Either direct memberships shown, or, with --nested
+    option, recursive.
+groupusers
+    Query group's member users.
+groupgroups
+    Query group's member groups.
+members
+    Query group's members - both users and groups.
+ismember
+    Check if given user is member of given group.