diff --git a/docs/developing_protocols.md b/docs/developing_protocols.md index 5b1610c..21bfe1e 100644 --- a/docs/developing_protocols.md +++ b/docs/developing_protocols.md @@ -6,4 +6,6 @@ - Conventions - Best practices - Sharing your protocol -- Co-protocols \ No newline at end of file +- 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/). diff --git a/docs/general_concepts.md b/docs/general_concepts.md index fe56d3b..a77edd9 100644 --- a/docs/general_concepts.md +++ b/docs/general_concepts.md @@ -1,3 +1,5 @@ # General Concepts -TODO \ No newline at end of file +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/). diff --git a/docs/index.md b/docs/index.md index 5d27892..0ca1ad6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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/). diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 789ea39..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,3 +0,0 @@ -# Implementers Guide - -This guide contains concepts, explanations, and important considerations for those building DIDComm capable systems. diff --git a/docs/libraries.md b/docs/libraries.md index 8e887bf..be79ae8 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -1,3 +1,25 @@ # Libraries -TODO \ No newline at end of file +## 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/). diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000..0b9d115 --- /dev/null +++ b/docs/quickstart.md @@ -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/). diff --git a/docs/repos.md b/docs/repos.md index 9fe81f0..f93240c 100644 --- a/docs/repos.md +++ b/docs/repos.md @@ -1,3 +1,12 @@ # Repositories -TODO \ No newline at end of file +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/). diff --git a/docs/timeouts.md b/docs/timeouts.md index e69de29..659b650 100644 --- a/docs/timeouts.md +++ b/docs/timeouts.md @@ -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/). diff --git a/mkdocs.yml b/mkdocs.yml index 5a89e1b..2ea574c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,7 +20,7 @@ nav: - OpenID4VC: oidc.md - scrapbook.md - Quick Start: - - intro.md + - quickstart.md - basics.md - 'Hello World': - hellolibstools.md