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

First page content, etc. #11

Merged
merged 1 commit into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 3 additions & 1 deletion docs/developing_protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@
- Conventions
- Best practices
- Sharing your protocol
- Co-protocols
- Co-protocols

>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
4 changes: 3 additions & 1 deletion docs/general_concepts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# General Concepts

TODO
TODO

>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
27 changes: 22 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
# DIDComm V2 Guidebook
# Overview
DIDComm is an open protocol for decentralized communication. You can use it to create
trustworthy relationships between people and businesses in a privacy-preserving way.

If you're a developer who wants to learn the practicalities of DIDComm -- getting started, common recipes, libraries and tools, the theory behind [the spec](https://identity.foundation/didcomm-messaging/spec/), or how your peers are solving interesting problems -- this is the place.
It uses DIDs ([Decentralized Identifiers](https://www.w3.org/TR/did-core/)), to establish confidential, ongoing connections, without
the need for usernames and passwords. You can then layer on existing services and applications
on top of DIDComm to take advantage of DIDComm's security, privacy and decentralization.
Read more about DIDComm and its benefits.

This is a living doc, updated and expanded regularly by the [DIDComm User Group](https://github.com/decentralized-identity/didcomm-usergroup). If you have suggestions for the book, we welcome your [contributions](../maintainer-guide.md); reach out to us on [Discord](https://discord.gg/eNN4Wns6Jb) or [email](https://lists.identity.foundation/g/didcomm-usergroup) for help.
## Developers
- Open standards protocol, continually improved by an active community.
- Fully decentralized with no central infrastructure.
- Transport independent: supports https, websockets, Bluetooth, and more.

>This version of the book focuses on [DIDComm v2](https://identity.foundation/didcomm-messaging/spec/v2.0/) (the one incubated by DIF, finalized in early 2022). For info about migration from [DIDComm v1](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0005-didcomm), see [Appendix: Migration from DIDComm v1](migration-v1.md). A new version of DIDComm, v3, is imagined. This would be an IETF standard that builds on v2 with a session construct, improved binary support, leaner messages for IoT, and so forth. When we have links for that work, we'll add them here.
See the [Quick Start](quickstart.md) guide for developers, or [browse the protocols](https://didcomm.org/search/) available to use.

>This book is a community-supported resource. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
## Applications
See the applications of DIDComm for:

- [Verifiable Credentials](applications/vc_tech_vertical.md)
- [Human communication](applications/human_communication_tech_vertical.md)

## Community
Join the [DIDComm User Group](workinggroups.md).

>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
3 changes: 0 additions & 3 deletions docs/intro.md

This file was deleted.

24 changes: 23 additions & 1 deletion docs/libraries.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Libraries

TODO
## DIDComm Libraries

* Python
* [DIDComm Python](https://github.com/sicpa-dlab/didcomm-python)
* Java, Kotlin, Android
* [DIDComm Java, Kotlin, Android](https://github.com/sicpa-dlab/didcomm-jvm)
* RUST
* [DIDComm RUST](https://github.com/sicpa-dlab/didcomm-rust)
* [JavaScript/TypeScript via WASM](https://github.com/sicpa-dlab/didcomm-rust/tree/main/wasm)
* [iOS via wrapper](https://github.com/sicpa-dlab/didcomm-rust/tree/main/wrappers/swift) is WIP
* other languages can be supported via wrappers

## Peer DID Libraries

Peer DIDs are a commonly used DID method to use with DIDComm. The following libraries can be used for Peer DID support.

* Python
* [Peer DID Python](https://github.com/sicpa-dlab/peer-did-python)
* Java, Kotlin, Android
* [Peer DID Java, Kotlin, Android](https://github.com/sicpa-dlab/peer-did-jvm)


>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
5 changes: 5 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Quick Start

This guide contains concepts, explanations, and important considerations for those building DIDComm capable systems.

>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
11 changes: 10 additions & 1 deletion docs/repos.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Repositories

TODO
The following repositories are relevant to DIDComm:

- [DIDComm v2 Specification](https://github.com/decentralized-identity/didcomm-messaging)

- [DIDComm.org](https://github.com/decentralized-identity/didcomm.org)

- [DIDComm Book](https://github.com/decentralized-identity/didcomm-book/)


>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
2 changes: 2 additions & 0 deletions docs/timeouts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

>Note: This book is a community-supported resource, under regular improvement. Corrections and contributions are welcome at our [GitHub Repo](https://github.com/decentralized-identity/didcomm-book/).
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ nav:
- OpenID4VC: oidc.md
- scrapbook.md
- Quick Start:
- intro.md
- quickstart.md
- basics.md
- 'Hello World':
- hellolibstools.md
Expand Down