From eb76b0b30d632d19de8a63623aadf945af0cfc09 Mon Sep 17 00:00:00 2001 From: emma Date: Mon, 19 Dec 2022 00:46:16 -0500 Subject: [PATCH] update README --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0e8f751..0b5d398 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ -`tomcat` – a [TOML](https://toml.io) parser in POSIX shell +`tomcat` – a minimal [TOML](https://toml.io) parser for the command line. ## Installation ### From Source -Clone this repository and move the `tomcat` binary wherever your operating -system stores locally-installed binaries. This is usually `/usr/local/bin` or -`$HOME/.local/bin` for your user. Make sure the installation location is in your -`$PATH`. +1. Run `cargo --install --git https://git.tebibyte.media/emma/tomcat.git` +2. ??? +3. Profit + +## Usage + +To get the value of `key` from the `main` table in `file.toml`: + +`tomcat main.key file.toml` + +To get the top-level key `notable` from `file.toml`: + +`tomcat notable file.toml` + +To get index `3` in array `arr` inside the `main` table in `file.toml`: + +`tomcat main.arr[3] file.toml`