README

README.md

@@ -1,20 +1,24 @@
-# khost
+## `kHOST`
+
+[<img alt="github" src="https://img.shields.io/badge/github-aspectron/khost-8da0cb?style=for-the-badge&labelColor=555555&color=8da0cb&logo=github" height="20">](https://github.com/aspectron/khost)
+<img alt="license" src="https://img.shields.io/crates/l/kHOST.svg?maxAge=2592000&color=6ac&style=for-the-badge&logoColor=fff" height="20">
 
 Kaspa p2p node deployment automation tool for Linux.
 
-This tool is designed to automate deployment of nodes intended for use as a part of the Kaspa public p2p network as well as private network clusters using wRPC.
+kHOST was created to automate deployment of Kaspa nodes intended for use as a part of the Kaspa public RPC network as well as private network high-availability clusters.  kHOST deploys Rusty-Kaspa nodes from sources, configures them to run as a `systemd` service as well as configures NGINX to act as a reverse proxy for the RPC.  This tool exists to simplify and automate Kaspa node deployment as well as to standardize related system configuration.
 
-## Setting up
+## Deploying
 
-As root:
+As `root`:
 
 ```bash
+sudo -s
 adduser -q kaspa
-sudo adduser kaspa sudo
+adduser kaspa sudo
 login kaspa
 ```
 
-As kaspa:
+As `kaspa` user:
 
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@@ -23,9 +27,8 @@ cargo install khost
 khost
 ```
 
+If you already have an existing user and rust installed, you can simply run `cargo install khost` followed by `khost`.
 
-If you already have an existing user and rust installed, you can simply run `cargo install khost` and then `khost`.
-
-Please note that the user needs to have root privileges to run khost.
+Please note that the user needs to have root (sudo) privileges to run khost.
 
-IMPORTANT: This tool creates it's own configuration for the kaspad node, as such, any previous configurations should be disabled and removed. If kaspad was running before under the same username, rusty-kaspa data folders will be re-used.
+IMPORTANT: This tool creates it's own configuration for the kaspad node, as such, any previous configurations should be disabled and removed. If kaspad was running before under the same username, the `~/.rusty-kaspa` data folders containing databases will be re-used.