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

restructured repo, added demo, added docs, added guide #78

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Prev Previous commit
Next Next commit
fixed formatting
andorsk committed Jan 9, 2025
commit d04f7f889dbb6310ff61b087b50ca2b867b963c8
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@
"description": "The Sample Network Trust Registry is a global registry of organizations that have agreed to accept the Sample Network Trust Registry as a source of trust for digital identity verification and attestation.",
"language": "en"
},
"organizations": [
"organizations": [
{
"name": "Sample Network 2",
"type": "organization",
@@ -37,7 +37,7 @@
"foundation.samplenetwork.certified.person.verify",
"foundation.samplenetwork.certified.person.issue"
],
"description": "The Sample Network is a sample network "
"description": "The Sample Network is a sample network",
"did": "did:web:samplenetwork.com",
"contronller": "did:web:samplenetwork.com",
"egfURI": "did:web:samplenetwork.com:governance",
Empty file removed reference_implementation/out.txt
Empty file.
40 changes: 40 additions & 0 deletions specification/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Trust Over IP Trust Registry Query Protocol Specification

This specification is basked on the [Trust Over IP Specification
Template](https://github.com/trustoverip/specification-template).

The spec is written using [SpecUp](https://github.com/decentralized-identity/spec-up) which is maintained by the
Decentralized Identity Foundation.


To browse the spec, see the [rendering on GitHub pages](https://trustoverip.github.io/tswg-trust-registry-protocol/). To
contribute to the spec, submit PRs that modify the .md files (in the `./spec` folder) that are used to generate the
.html files in this folder.

Before submitting a PR, please see the [Editing The Spec](./docs/EditingTheSpec.md) document for guidance on generating the
specification locally for review.

## Repository Structure

# Folder Structure

## `specification`
This folder contains the core specification documentation. The rendered version is available at
[https://trustoverip.github.io/tswg-trust-registry-protocol/](https://trustoverip.github.io/tswg-trust-registry-protocol/).

## `docs`
This folder includes user guides and other supporting documentation to enhance usability and understanding.

## `profiles`
This folder provides a registry of TRQP profiles. These profiles are intended to demonstrate how a profile might be structured for learning purposes. They are not intended to represent definitive or production-ready profiles.

## `reference_implementation`
This folder contains a simple reference implementation using a JSON file as the registry. It serves as a teaching tool and is not designed for production environments.

## Rendering Spec-Up

To run Spec-up in live edit mode (will re-render upon save), in project folder run:

```
npm run edit
```