apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-04-25 00:16:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Revise quickstart instructions in README.md (#758)

Browse source 
Updated the README to clarify the configuration process and improve wording.
This commit is contained in:
Jack Colquitt 2026-04-04 13:34:12 -07:00 • committed by GitHub
parent 2f484b4c15
commit 8d1a4ae3bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -63,12 +63,14 @@ Everything else is included.
## Quickstart ## Quickstart
There's no need to clone this repo, unless you want to build from source. TrustGraph is a fully containerized app that deploys as a set of Docker containers. To configure TrustGraph on the command line:
``` ```
npx @trustgraph/config npx @trustgraph/config
``` ```
TrustGraph downloads as Docker containers and can be run locally with Docker, Podman, or Minikube. The config tool will generate: The config process will generate app config that can be run locally with Docker, Podman, or Minikube. The process will output:
- `deploy.zip` with either a `docker-compose.yaml` file for a Docker/Podman deploy or `resources.yaml` for Kubernetes - `deploy.zip` with either a `docker-compose.yaml` file for a Docker/Podman or `resources.yaml` for Kubernetes
- Deployment instructions as `INSTALLATION.md` - Deployment instructions as `INSTALLATION.md`
<p align="center"> <p align="center">
@ -76,7 +78,7 @@ TrustGraph downloads as Docker containers and can be run locally with Docker, Po
width="80%" controls></video> width="80%" controls></video>
</p> </p>
For a browser based quickstart, try the [Configuration Terminal](https://config-ui.demo.trustgraph.ai/). For a browser based configuration, try the [Configuration Terminal](https://config-ui.demo.trustgraph.ai/).
<details> <details>
<summary>Table of Contents</summary> <summary>Table of Contents</summary>