From c82a5db05a879446e3823c898250679260e4d99c Mon Sep 17 00:00:00 2001 From: Leon Mika Date: Thu, 28 Jul 2022 22:17:47 +1000 Subject: [PATCH] A slightly better README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aaa61fa..469e590 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# awstools -Various admin tools for AWS +# Audax Toolset + +A set of small, terminal based UI (TUI, sometimes called "Rougelike") tools for +administering AWS services. + +They were built to make it easy to do quick things with +common AWS services, such as DynamoDB, without having to learn incantations with the CLI or +go to the AWS console itself. This keeps you focused on your task and saves you from +breaking concentration, especially if you do a lot in the terminal. + +## The Toolset + +More info about the available tools are available here: + +- [dynamo-browse](https://audax.tools/docs/dynamo-browse): Browse DynamoDB tables + +## Install + +Binary packages can be [download from the release page](https://github.com/lmika/audax/releases/latest). + +If you have Go 1.18, you can install using the following command: + +``` +go install github.com/lmika/audax/cmd/dynamo-browse@v0.0.2 +``` + +## License + +Audax toolset is released under the MIT License. \ No newline at end of file