added console viz and instructions to README

aserto-dev · Nov 6, 2023 · 17c8ce8 · 17c8ce8
1 parent 129eff7
commit 17c8ce8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ It uses the [Open Policy Agent](https://www.openpolicyagent.org/) (OPA) as its d
 
 Authorization policies can leverage user attributes, group membership, application resources, and relationships between them. All data used for authorization is modeled and stored locally in an embedded database, so authorization decisions can be evaluated quickly and efficiently.
 
+<img src="assets/topaz_model_viz.gif" alt="topaz model visualization">
+
 ## Documentation and support
 
 Read more at [topaz.sh](https://www.topaz.sh) and the [docs](https://www.topaz.sh/docs/intro).
@@ -154,6 +156,12 @@ Import the contents of the file into Topaz directory. This creates the sample us
 topaz import -i -d .
 ```
 
+### Bring up the console
+
+```shell
+topaz console
+```
+
 ### Issue an API call
 
 To verify that Topaz is running with the right policy image, you can issue a `curl` call to interact with the REST API.

diff --git a/assets/topaz_model_viz.gif b/assets/topaz_model_viz.gif