Skip to content

Commit c577d73

Browse files
committed
improve readme
1 parent be185a8 commit c577d73

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

Readme.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
<div align="center">
22
<a href="https://github.com/ucan-wg/go-ucan" target="_blank">
3-
<img src="https://raw.githubusercontent.com/ucan-wg/go-ucan/main/assets/logo.png" alt="go-ucan Logo" height="250"></img>
3+
<img src="https://raw.githubusercontent.com/ucan-wg/go-ucan/v1/assets/logo.png" alt="go-ucan Logo" height="250"></img>
44
</a>
55

66
<h1 align="center">go-ucan</h1>
77

88
<p>
9-
<img src="https://img.shields.io/badge/UCAN-v1.0.0--rc.1-blue
10-
" alt="UCAN v1.0.0-rc.1">
9+
<img src="https://img.shields.io/badge/UCAN-v1.0.0--rc.1-blue" alt="UCAN v1.0.0-rc.1">
1110
<a href="https://github.com/ucan-wg/go-ucan/tags">
12-
<img alt="GitHub go.mod Go version" src="https://img.shields.io/github/go-mod/go-version/ucan-wg/go-ucan">
11+
<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/ucan-wg/go-ucan">
1312
</a>
1413
<a href="https://github.com/ucan-wg/go-ucan/actions?query=">
1514
<img src="https://github.com/ucan-wg/go-ucan/actions/workflows/gotest.yml/badge.svg" alt="Build Status">
1615
</a>
17-
<a href="https://github.com/ucan-wg/go-ucan/blob/main/LICENSE.md">
18-
<img alt="Apache 2.0 License" src="https://img.shields.io/badge/License-Apache--2.0-green">
19-
<img alt="MIT License" src="https://img.shields.io/badge/License-MIT-green">
16+
<a href="https://ucan-wg.github.io/go-ucan/dev/bench/">
17+
<img alt="Go benchmarks" src="https://img.shields.io/badge/Benchmarks-go-blue">
18+
</a>
19+
<a href="https://github.com/ucan-wg/go-ucan/blob/v1/LICENSE.md">
20+
<img alt="Apache 2.0 + MIT License" src="https://img.shields.io/badge/License-Apache--2.0+MIT-green">
2021
</a>
2122
<a href="https://pkg.go.dev/github.com/ucan-wg/go-ucan">
2223
<img src="https://img.shields.io/badge/Docs-godoc-blue" alt="Docs">
@@ -30,7 +31,11 @@
3031
This is a go library to help the next generation of web and decentralized applications make use
3132
of UCANs in their authorization flows.
3233

33-
## Specifications
34+
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.
35+
36+
## Resources
37+
38+
### Specifications
3439

3540
The UCAN specification is separated in multiple sub-spec:
3641
- [Main specification](https://github.com/ucan-wg/spec)
@@ -41,13 +46,19 @@ Not implemented yet:
4146
- [Revocation](https://github.com/ucan-wg/revocation/tree/first-draft)
4247
- [Promise](https://github.com/ucan-wg/promise/tree/v1-rc1)
4348

49+
### Talks
50+
51+
- [Decentralizing Auth, and UCAN Too - Brooklyn Zelenka (2023)](https://www.youtube.com/watch?v=MuHfrqw9gQA)
52+
- [What's New in UCAN 1.0 - Brooklyn Zelenka (2024)](https://www.youtube.com/watch?v=-uohQzZcwF4)
53+
4454
## Status
4555

4656
`go-ucan` currently support the required parts of the UCAN specification: the main specification, delegation and invocation.
4757

4858
Besides that, `go-ucan` also includes:
4959
- a simplified [DID](https://www.w3.org/TR/did-core/) and [did-key](https://w3c-ccg.github.io/did-method-key/) implementation
5060
- 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
61+
- support for encrypted values in token's metadata
5162

5263
## Getting Help
5364

@@ -57,6 +68,10 @@ For usage questions, usecases, or issues reach out to us in our `go-ucan`
5768
We would be happy to try to answer your question or try opening a new issue on
5869
Github.
5970

71+
## UCAN Gopher
72+
73+
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)
74+
6075
## License
6176

62-
This project is licensed under the double license [Apache 2.0 + MIT](https://github.com/ucan-wg/go-ucan/blob/main/LICENSE.md).
77+
This project is licensed under the double license [Apache 2.0 + MIT](https://github.com/ucan-wg/go-ucan/blob/v1/LICENSE.md).

0 commit comments

Comments
 (0)