From 294b08297f4b3b704cb7f33e57e63f18eea8fdaf Mon Sep 17 00:00:00 2001 From: Maxwell Date: Mon, 21 Oct 2024 09:02:34 +1100 Subject: [PATCH] Update client-cli/README.md --- client-cli/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/client-cli/README.md b/client-cli/README.md index 167f3ed..bda6cf9 100644 --- a/client-cli/README.md +++ b/client-cli/README.md @@ -1,3 +1,26 @@ # Chookpen Client (CLI) This is the reference client for Chookpen. It is quite a basic client. This is a good starting point if you need an example, or are building a GUI Kotlin client. + +## Features + +* Profile file +* Create account (buggy) +* Log into existing account +* Sync messages +* Send message +* Auto hash password +* Configure whether HTTPS is used + +## Documentation + +To run this client, do the following: + +1. Install Java 17+ and Gradle. +2. `git clone https://git.maxwellj.xyz/max/chookpen` +3. In the client-cli directory of the git repo, run `gradle installDist`. +5. Inside build/install/bin, create a .chookpen.profile file that looks like this: ```name:password:server:port:0``` +6. Run the script in build/install/bin, or the bat file if you're a crazy weird guy who uses Windows (Make sure to use the command line otherwise it'll close instantly) +7. If you'd like to send a message, add that as your argument after specifying the script. + +Note: The password in .chookpen.profile is hashed by the client. If you're just testing the server, set your password to `dingus`. The hash recognised by the server for that password is `750c63441033127dccaa91c16b21614e`. Create an account with the method specified in the root README using that password. \ No newline at end of file