From c577d73f3ee7c8c62717be547730675851329b21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Mur=C3=A9?= Date: Tue, 12 Nov 2024 17:44:28 +0100 Subject: [PATCH] improve readme --- Readme.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/Readme.md b/Readme.md index ef565ab..8944775 100644 --- a/Readme.md +++ b/Readme.md @@ -1,22 +1,23 @@
- go-ucan Logo + go-ucan Logo

go-ucan

- UCAN v1.0.0-rc.1 + UCAN v1.0.0-rc.1 - GitHub go.mod Go version + GitHub Tag Build Status - - Apache 2.0 License - MIT License + + Go benchmarks + + + Apache 2.0 + MIT License Docs @@ -30,7 +31,11 @@ This is a go library to help the next generation of web and decentralized applications make use of UCANs in their authorization flows. -## Specifications +User Controlled Authorization Networks (UCANs) are a way of doing authorization where users are fully in control. OAuth is designed for a centralized world, UCAN is the distributed user controlled version. + +## Resources + +### Specifications The UCAN specification is separated in multiple sub-spec: - [Main specification](https://github.com/ucan-wg/spec) @@ -41,6 +46,11 @@ Not implemented yet: - [Revocation](https://github.com/ucan-wg/revocation/tree/first-draft) - [Promise](https://github.com/ucan-wg/promise/tree/v1-rc1) +### Talks + +- [Decentralizing Auth, and UCAN Too - Brooklyn Zelenka (2023)](https://www.youtube.com/watch?v=MuHfrqw9gQA) +- [What's New in UCAN 1.0 - Brooklyn Zelenka (2024)](https://www.youtube.com/watch?v=-uohQzZcwF4) + ## Status `go-ucan` currently support the required parts of the UCAN specification: the main specification, delegation and invocation. @@ -48,6 +58,7 @@ Not implemented yet: Besides that, `go-ucan` also includes: - a simplified [DID](https://www.w3.org/TR/did-core/) and [did-key](https://w3c-ccg.github.io/did-method-key/) implementation - a [token container](https://github.com/ucan-wg/go-ucan/tree/v1/pkg/container) with CBOR and CAR format, to package and carry tokens together +- support for encrypted values in token's metadata ## Getting Help @@ -57,6 +68,10 @@ For usage questions, usecases, or issues reach out to us in our `go-ucan` We would be happy to try to answer your question or try opening a new issue on Github. +## UCAN Gopher + +Artwork by [Bruno Monts](https://www.instagram.com/bruno_monts). Thank you [Renee French](http://reneefrench.blogspot.com/) for creating the [Go Gopher](https://blog.golang.org/gopher) + ## License -This project is licensed under the double license [Apache 2.0 + MIT](https://github.com/ucan-wg/go-ucan/blob/main/LICENSE.md). \ No newline at end of file +This project is licensed under the double license [Apache 2.0 + MIT](https://github.com/ucan-wg/go-ucan/blob/v1/LICENSE.md).