README.md

@@ -1,7 +1,21 @@
 # ahj - American Headset Jack
 
-This is a weird obfuscated network protocol that was originally meant to be a VPN.
+This is a weird obfuscated network protocol that was originally meant to be part
+of a VPN.
 
 ## The name makes no sense
 
 Yep.
+
+## How to use
+
+Documentation will be made soon. For now, see jsdoc.
+
+For examples, see test/client.js and test/server.js.
+
+To generate configuration:
+
+1. `bin/generate-config.js <host> <port>` to generate server configuration
+2. `bin/generate-verifier.js` to generate salt and verifier
+3. `bin/adduser.js` to add client to server configuration and to generate
+a configuration template for the client

bin/adduser.js

@@ -8,6 +8,7 @@ const readAsync = util.promisify(read);
  * Generates client configuration files and adds credentials to the
  * server configuration file.
  * Usage: node bin/adduser.js [<server config>] [<username>] [<salt>] [<verifier>]
+ * If username, salt, and/or verifier are not given, they will be prompted for.
  */
 async function main() {
   let configPath = process.argv[2] || 'serverconfig.json';