Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clean up the README #154

Merged
merged 1 commit into from
Apr 6, 2022
Merged

docs: clean up the README #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 10 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,10 @@
/>
</p>


<h1 align="center" ><b>Aries CLI</b></h1>


<h3 align="center">Powered by &nbsp; <img src="./images/animo-logo-dark-background.png#gh-dark-mode-only" height="12px"><img src="./images/animo-logo-light-background.png#gh-light-mode-only" height="12px"></h3><br>



<p align="center">
<a href="#getting-started">Getting started</a> &nbsp;|&nbsp;
<a href="#roadmap">Roadmap</a> &nbsp;|&nbsp;
Expand All @@ -31,43 +27,43 @@

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 🚧)
Comment on lines +30 to +32
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nooo why remove the emojis 😎

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:-(


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).

### 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.
Expand Down Expand Up @@ -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).