From 15d25a98207ad2d0b5c46275a384890ce258560f Mon Sep 17 00:00:00 2001 From: Dave Grijalva Date: Tue, 27 May 2014 14:23:32 -0700 Subject: [PATCH] updated documentation for 1.0.0 --- README.md | 8 ++++++-- VERSION_HISTORY.md | 8 ++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 VERSION_HISTORY.md diff --git a/README.md b/README.md index e058af6..852beab 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ The part in the middle is the interesting bit. It's called the Claims and conta This library supports the parsing and verification as well as the generation and signing of JWTs. Current supported signing algorithms are RSA256 and HMAC SHA256, though hooks are present for adding your own. -This library is considered production ready. Feedback and feature requests are appreciated. - ## Parse and Verify Parsing and verifying tokens is pretty straight forward. You pass in the token and a function for looking up the key. This is done as a callback since you may need to parse the token to find out what signing method and key was used. @@ -42,6 +40,12 @@ Parsing and verifying tokens is pretty straight forward. You pass in the token tokenString, err := token.SignedString(mySigningKey) ``` +## Project Status & Versioning + +This library is considered production ready. Feedback and feature requests are appreciated. The API should be considered stable. There should be very few backwards-incompatible changes outside of major version updates (and only with good reason). + +This project uses [Semantic Versioning 2.0.0](http://semver.org). Accepted pull requests will land on `master`. Periodically, versions will be tagged from `master`. You can find all the releases on [the project releases page](https://github.com/dgrijalva/jwt-go/releases). + ## More Documentation can be found [on godoc.org](http://godoc.org/github.com/dgrijalva/jwt-go). diff --git a/VERSION_HISTORY.md b/VERSION_HISTORY.md new file mode 100644 index 0000000..3fbe219 --- /dev/null +++ b/VERSION_HISTORY.md @@ -0,0 +1,8 @@ +## `jwt-go` Version History + +#### 1.0.0 + +* First versioned release +* API stabilized +* Supports creating, signing, parsing, and validating JWT tokens +* Supports RS256 and HS256 signing methods \ No newline at end of file