From 067389efa2a57c44886a88ee87703a77f470ffae Mon Sep 17 00:00:00 2001 From: Joscha Date: Thu, 1 Sep 2022 21:09:22 +0200 Subject: [PATCH] Move "Using cove" section to the top It is fairly important and easily missed if it is placed after the long "Manual install" section. If I ever add easier ways to install cove (like providing prebuilt binaries or packaging it on some package managers), I might change this order again and refer to the "Using cove" section in the top paragraph instead. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7cdfd17..7a07eea 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,17 @@ real-time chat platform. It runs on Linux, Windows and macOS. +## Using cove + +To start cove, simply run `cove` in your terminal. For more info about the +available subcommands such as exporting room logs or resetting cookies, run +`cove --help`. + +If you delete rooms, cove's vault (the database it stores messages and other +things in) won't automatically shrink. If it takes up too much space, try +running `cove gc` and waiting for it to finish. This isn't done automatically +because it can take quite a while. + ## Manual installation This section contains instructions on how to install cove by compiling it yourself. @@ -55,14 +66,3 @@ in the full version you want to install: ```bash $ cargo install --force --git https://github.com/Garmelon/cove --tag v0.1.0 ``` - -### Using cove - -To start cove, simply run `cove` in your terminal. For more info about the -available subcommands such as exporting room logs or resetting cookies, run -`cove --help`. - -If you delete rooms, cove's vault (the database it stores messages and other -things in) won't automatically shrink. If it takes up too much space, try -running `cove gc` and waiting for it to finish. This isn't done automatically -because it can take quite a while.