more readme

README.md

@@ -5,5 +5,22 @@ It doesn't come with a backend because you're expected to bring your own. A plai
 
 This project is separated into a library and a desktop application (targeting mainly GNU/Linux), with an Android application in the works.
 
-## How to use
+## How to build
+Run `mvn clean install` in this directory to build the `lib` and `desktop` modules.
+
+If the `ANDROID_HOME` environment variable exists, `android` will also be built.
+
+## How to install
+### GNU/Linux
+`desktop` contains a wrapper script that will call the version of `piecannon-desktop-app` installed in your maven repository, and then open the uploaded file in your browser. You can copy or symlink this wrapper script anywhere. Typically you would put it in `~/bin` or `~/.local/bin`. Make sure that directory is in your `PATH`.
+
+### Windows
 TODO
+
+### Mac OS
+TODO
+
+## How to use
+Place a `servers.json` in your `XDG_DATA_HOME`, by default this would be `~/.local/share/piecannon` (create this directory if it does not exist. See `servers.example.json` for an example of such a file. Whenever you initiate a file upload, Pie Cannon will select one of your defined servers at random and upload the file.
+
+For SFTP servers (the only supported type as of now), the `path` is relative to your home directory and should be where `url` points to. i.e. a file uploaded to `path` should be downloadable at `url`. In the future Pie Cannon should be able to get SSH credentials from your agent so you won't need to put a password in this file.

servers.example.json

@@ -0,0 +1,7 @@
+[{
+    "host": "example.com",
+    "username": "username",
+    "password": "password",
+    "path": "www/stuff",
+    "url": "https://example.com/stuff"
+}]