From 7f034eba9fefd636682935074cd038669e3bb190 Mon Sep 17 00:00:00 2001 From: blu3beri Date: Wed, 6 Apr 2022 10:11:09 +0200 Subject: [PATCH] docs: clean up the README Signed-off-by: blu3beri --- README.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 10ec34f8..233fdefe 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,10 @@ />

-

Aries CLI

-

Powered by  


- -

Getting started  |  Roadmap  |  @@ -31,13 +27,12 @@ Aries CLI is the most convenient way for self-sovereign identity (SSI) developers to interact with SSI agents. -* 🌐 **Environments** to easily manage configuration for multiple projects and agents -* 🌟 **Automations** that you can perform against an agent -* 💅🏻 **Mock data** so that you can focus on the important task of building your application instead of other foobar (coming soon 🚧) +* **Environments** to easily manage configuration for multiple projects and agents +* **Automations** that you can perform against an agent +* **Mock data** so that you can focus on the important task of building your application instead of other foobar (coming soon 🚧) If you are looking for more information about the concepts, example code and tutorials on how to use the CLI we recommend you check out our extensive [docs](https://docs.aries-cli.animo.id/). - ## Getting started Heres how to install Aries-CLI using the most popular package managers. For advanced installation options, binaries and troubleshooting we recommend checking out the [installation guide](https://docs.aries-cli.animo.id/guides/installation). @@ -45,29 +40,30 @@ Heres how to install Aries-CLI using the most popular package managers. For adva ### macOS using Brew ```sh -brew tap animo/aries-cli && brew install aries-cli +brew tap animo/aries-cli +brew install aries-cli ``` ### Cargo install ```sh cargo install --git https://github.com/animo/aries-cli -### Setting up your environment +``` + +## Quickly getting started + +In order to work with the Aries-CLI an agent needs to be configured. With the following command you connect with our community agent and can access all the functionality. ```sh aries-cli configuration add --default -# > /location/of/the/config/file ``` This command will set up the community agent. To set up your own agent or use our multitenant agent to get your own environment, see the [set up guide](https://docs.aries-cli.animo.id/guides/configuration). - If you are getting started with the tool we recommend enabling informational logs by passing the `--verbose` (or `-v`) flag. To see all actions simply use the `--help` or `-h` flag or see the [feature overview](https://docs.aries-cli.animo.id/features/introduction). - - ## Roadmap We intend to support multiple versions of the Aries agent. See the CLI help `aries-cli --help` for a list of actions we currently support. @@ -98,5 +94,3 @@ We intend to support multiple versions of the Aries agent. See the CLI help `ari Is there something you'd like to fix or add to the CLI? Great! We 💗 community contributions. [Get involved](https://docs.aries-cli.animo.id/community/contributing). - -