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

Making README shorter #124

Merged
merged 7 commits into from
Mar 31, 2022
Merged

Making README shorter #124

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2cd5d4f
Making README shorter
jloleysens Mar 30, 2022
ede3682
put it in the middle
jloleysens Mar 30, 2022
867de5a
Update README.md
jloleysens Mar 30, 2022
d18038b
replace with instead of optionally
jloleysens Mar 30, 2022
93ee080
By -> by
jloleysens Mar 30, 2022
c371d84
also tighten up contributing guide
jloleysens Mar 30, 2022
7232ddd
less ambiguous and fix grammar
jloleysens Mar 30, 2022
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
73 changes: 40 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,38 +21,22 @@


<p align="center">
<a href="#roadmap">Roadmap</a> &nbsp;|&nbsp;
<a href="#getting-started">Getting started</a> &nbsp;|&nbsp;
<a href="#getting-started">Getting started</a> &nbsp;|&nbsp;
<a href="#common-examples">Common examples</a> &nbsp;|&nbsp;
<a href="#contributing">Contributing</a>
<a href="#roadmap">Roadmap</a> &nbsp;|&nbsp;
<a href="#contributing">Contributing</a>

</p>

<!-- Add badges? -->

Aries CLI is the most convenient way for self-sovereign identity (SSI) developers to interact with SSI agents.

Building an SSI solution requires many, _many_ interactions with an SSI agent. Each interaction, often comprised of multiple steps, must be furnished with an endpoint and associated data. The Aries CLI makes working with verifiable credentials easy by giving users:

* 🌐 **Environments** to easily manage configuration for multiple projects and agents
* 🌟 **Actions and workflows** 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 🚧)

This README was set up for you to get started as fast as possible. 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://github.com/animo/aries-cli/pull/www.google.com).

## Roadmap

<!-- 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. |
| Workflows | 🚧 | Chain multiple actions together for higher-level goals like: issue a credential. |
| Present proof | 🚧 | Present proofs. |
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://github.com/animo/aries-cli/pull/www.google.com).


## Getting started
Expand All @@ -77,35 +61,43 @@ echo "Coming soon!"
Write-Output "Coming soon!"
```

### Binaries

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

jloleysens marked this conversation as resolved.
Show resolved Hide resolved
### Setting up your environment

```sh
aries-cli configuration initialize
# > /location/of/the/config/file
```

We highly recommend using `environment`s to avoid the repetitive task of
specifying agent URLs. With this CLI you can get up and running with our
community agent as your default environment, or use your own agent.
This command will set up the community agent. To set up your own agent edit
the configuration file by adding your agent URL.

If you are getting started with the tool, we recommend enabling informational logs by
passing the `--verbose` (or `-v`) flag to get more information about what the CLI is
doing. We also support stacking verbosity up to three levels for debug logs: `-vv` and `-vvv`.
If you are getting started with the tool we recommend enabling informational logs by
passing the `--verbose` (or `-v`).

## Common examples
Copy link
Member

Choose a reason for hiding this comment

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

Not too sure if the common example should be included in the README.md

Copy link
Contributor Author

@jloleysens jloleysens Mar 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

i think it is a natural flow for new users after getting set up which is nice. Ideally we'd send them to the docs that'll be more comprehensive after that. In short, I think it'd be nice to keep for now, then possibly link out to docs and shorten or remove in future. WDYT?


Below you will find some of the most common useful commands within the Aries CLI. To see all options, simply use the `--help` or `-h` flag.
To see all actions simply use the `--help` or `-h` flag. Here are some common actions.

### Creating an invitation for the toolbox
### Create a credential offer

```sh
aries-cli --copy --verbose connections invite --toolbox
aries-cli execute offer-credential
```

With this quick-fire way of creating an invite to the [Aries toolbox](https://github.com/hyperledger/aries-toolbox) you can continue
with the task at hand: testing an invitation workflow for your app. This
command takes care of all the plumbing.
Get a credential offer in your wallet &mdash; this command will execute all of the actions needed.

The `--toolbox` flag makes sure the invite has an alias as Toolbox, sets auto accept to true and sets the toolbox as admin for the invite.

### Create an invitation for the toolbox
Copy link
Member

Choose a reason for hiding this comment

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

Same for this


```sh
aries-cli --copy --verbose connections invite --toolbox
```

The `--toolbox` flag creates an invitation for the [Toolbox](https://github.com/hyperledger/aries-toolbox).

The `--copy` flag will copy the invite URL to your clipboard so it can easily be pasted in the toolbox

Expand All @@ -117,6 +109,21 @@ For more options under the `connections invite` subcommand see:
aries-cli connections invite --help
```


## Roadmap

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

## Contributing

Is there something you'd like to fix or add to the CLI? Great! We 💗 community
Expand Down