8000 doc: in v3 branch's README, point to v4 as latest (#101) · go-jose/go-jose@11bb4e7 · GitHub
[go: up one dir, main page]

Skip to content

Commit 11bb4e7

Browse files
authored
doc: in v3 branch's README, point to v4 as latest (#101)
Also: - move the Versions stanza to the top - remove the Help Wanted - remove the doc / build badges Since this is not the main branch, it will mainly be viewed on pkg.go.dev after we make a patchlevel release.
1 parent 863f73b commit 11bb4e7

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Go JOSE
22

3-
[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v3.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v3)
4-
[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v3/jwt.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v3/jwt)
5-
[![license](https://img.shields.io/badge/license-apache_2.0-blue.svg?style=flat)](https://raw.githubusercontent.com/go-jose/go-jose/master/LICENSE)
6-
[![test](https://img.shields.io/github/checks-status/go-jose/go-jose/v3)](https://github.com/go-jose/go-jose/actions)
3+
### Versions
4+
5+
[Version 4](https://github.com/go-jose/go-jose)
6+
([branch](https://github.com/go-jose/go-jose/),
7+
[doc](https://pkg.go.dev/github.com/go-jose/go-jose/v4), [releases](https://github.com/go-jose/go-jose/releases)) is the current stable version:
8+
9+
import "github.com/go-jose/go-jose/v4"
10+
11+
The old [square/go-jose](https://github.com/square/go-jose) repo contains the prior v1 and v2 versions, which
12+
are deprecated.
13+
14+
### Summary
715

816
Package jose aims to provide an implementation of the Javascript Object Signing
917
and Encryption set of standards. This includes support for JSON Web Encryption,
1018
JSON Web Signature, and JSON Web Token standards.
1119

12-
**Help Wanted!** If you'd like to help us develop this library please reach
13-
out to css (at) css.bio. While I'm still working on keeping this maintained,
14-
I have limited time for in-depth development and could use some additional help.
15-
1620
**Disclaimer**: This library contains encryption software that is subject to
1721
the U.S. Export Administration Regulations. You may not export, re-export,
1822
transfer or download this code or any part of it in violation of any United
@@ -39,17 +43,6 @@ of [case-insensitive matching](https://www.ietf.org/mail-archive/web/json/curren
3943
This is to avoid differences in interpretation of messages between go-jose and
4044
libraries in other languages.
4145

42-
### Versions
43-
44-
[Version 3](https://github.com/go-jose/go-jose)
45-
([branch](https://github.com/go-jose/go-jose/tree/v3),
46-
[doc](https://pkg.go.dev/github.com/go-jose/go-jose/v3), [releases](https://github.com/go-jose/go-jose/releases)) is the current stable version:
47-
48-
import "github.com/go-jose/go-jose/v3"
49-
50-
The old [square/go-jose](https://github.com/square/go-jose) repo contains the prior v1 and v2 versions, which
51-
are still useable but not actively developed anymore.
52-
5346
### Supported algorithms
5447

5548
See below for a table of supported algorithms. Algorithm identifiers match

0 commit comments

Comments
 (0)
0