aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/client.txt')
-rw-r--r--docs/client.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/client.txt b/docs/client.txt
new file mode 100644
index 0000000..c0dbd23
--- /dev/null
+++ b/docs/client.txt
@@ -0,0 +1,12 @@
+
+To install the client, use the ebuild found in the
+overlay/app-portage/gentoostats directory.
+
+An uuid and password will be automagically generated and saved in
+/etc/gentoostats/auth.cfg
+
+To restrict submission of specific stats, edit /etc/gentoostats/payload.cfg
+
+To submit your stats, run gentoostats-send as root.
+
+To access stats on the command line, use gentoostats-cli.