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.

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

Updated with roadmap #142

Merged
merged 4 commits into from
Apr 5, 2022
Merged
Changes from 1 commit
Commits
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
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Heres how to install Aries-CLI using the most popular package managers. For adva
### macOS using Brew

```sh
echo "Coming soon!"
brew install aries-cli
Copy link
Member

Choose a reason for hiding this comment

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

brew tap animo

Suggested change
brew install aries-cli
brew tap animo/aries-cli
brew install aries-cli

Copy link
Contributor

Choose a reason for hiding this comment

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

that's the correct way

```

### Linux using Apt-get
Expand All @@ -64,6 +64,7 @@ Write-Output "Coming soon!"
### Binaries

See [binaries](https://github.com/animo/aries-cli/releases).

### Cargo install

```sh
Expand Down Expand Up @@ -118,14 +119,27 @@ aries-cli connections invite --help
<!-- TODO: Add more details about the actions and features we support -->
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.

Next we are looking at adding:

| Feature | Status | Description |
| ---------------- | ------ | ------------------------------------------------------------------------------------- |
| Mock data | 🚧 | Generate mock data for large data structures like schemas and credential definitions. |
| Filters | 🚧 | Use filters to determine what server output you want returned. |
| execute offer-credential | ✅ | Execute sequence of actions to get a credential offer in your wallet. |
| Present proof | 🚧 | Present proofs. |
| Environments |✅ | Support multiple environments. |
| Connections | ✅ | Retrieve connections or create invitations. |
| Schemas | ✅ | Retrieve or create schemas. |
| Credentials | ✅ | Offer or propose credentials. |
| ACA-Py 0.7.3 support | ✅ | ACA-Py 0.7.3 support. |
| Verbosity | ✅ | Three verbosity levels and error messages. |
| Automation: offer credential mocked | ✅ | Offer a mocked data credential through an automation. |
| Community agent | ✅ | Default use with the Animo community agent. |
| Multitenancy | ✅ | Use a personal agent environment with your personal token. |
| Brew install | ✅ | Brew install. |
| Proofs | ✅ | Proofs. |
| Apt-get install | 🚧 | Apt-get install. |
| Chocolaty install | 🚧 | Chocolaty install. |
| Automation: offer credential custom | 🚧 | Offer a custom data credential through an automation. |
| Filters | 🚧 | Use filters to determine what output you want returned. |
| Automation: definitions custom | 🚧 | Create a schema + credential definition with custom data through an automation. |
| Automation: proofs mock | 🚧 | Present proof with mock data through an automation. |
| Automation: proofs custom | 🚧 | Present proof with custom data through an automation. |


## Contributing

Expand Down