diff --git a/CHANGELOG.md b/CHANGELOG.md index c54376e..22e0f5d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,35 @@ All notable changes to this project will be documented in this file. +## [1.11.2] - 2024-10-24 + +### Added + +- chore: LICENSE file added + +### Changed + +- docs: README updated +- docs: update Passage Docs link +- ci: pin gorename to v0.24.0 to avoid conflict with go runtime 1.20.0 +- test: fix test user identifier conflict + +## [1.11.1] - 2024-07-29 + +### Changed + +- chore(deps): bump github.com/lestrrat-go/jwx from 1.2.26 to 1.2.29 + +## [1.11.1] - 2024-10-24 + +### Added + +- LICENSE file added + +### Changed + +- README updated + ## [1.11.0] - 2024-03-21 ### Added @@ -20,4 +49,4 @@ All notable changes to this project will be documented in this file. - `UserEventInfo` has been renamed to `UserRecentEvent` - Docs have been moved to `/docs` - `GithubSocialConnection` has been renamed to `GithubUserSocialConnection` -- `GoogleSocialConnection` has been renamed to `GoogleUserSocialConnection` \ No newline at end of file +- `GoogleSocialConnection` has been renamed to `GoogleUserSocialConnection` diff --git a/LICENSE b/LICENSE index 25a3cfa..3442d75 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Passage Identity, Inc. +Copyright (c) 2024 Passage by 1Password Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b789b40..19ceb5d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,80 @@ -# Passage Go +![passage-go](https://storage.googleapis.com/passage-docs/github-md-assets/passage-go.png) -[![Go Reference](https://pkg.go.dev/badge/github.com/passageidentity/passage-go.svg)](https://pkg.go.dev/github.com/passageidentity/passage-go) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/passageidentity/passage-go) +![Golang](https://img.shields.io/badge/golang-00ADD8?&style=plastic&logo=go&logoColor=white) +![GitHub License](https://img.shields.io/github/license/passageidentity/passage-go) +![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password) -✨ Easily authenticate requests and manage Passage users. +## About -📚 See examples in the [Passage docs](https://docs.passage.id/complete/backend-sdks/go). +[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease. -🔎 Reference detailed documentation in the [Go Reference](https://pkg.go.dev/github.com/passageidentity/passage-go). +Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience. + +Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution. + +Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys. + +### In passage-go + +Use passage-go to implement Passkey Complete into your Go backend to authenticate requests and manage users. + +| Product | Compatible | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** | ✖️ For Passkey Flex, check out the [Passkey Flex APIs](https://docs.passage.id/flex/apis) | +| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** | ✅ | +| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit](https://www.npmjs.com/package/@passageidentity/authentikit) | + +## Getting Started + +### Check Prerequisites + +

+ You'll need a free Passage account and a Passkey Complete app set up in Passage Console to get started.
+ Learn more about Passage Console → +

+ +### Install + +```shell +go get github.com/passageidentity/passage-go +``` + +### Import + +```go +import ( + "github.com/passageidentity/passage-go" +) +``` + +### Initialize + +```go +psg, err := passage.New(os.Getenv("PASSAGE_APP_ID"), &passage.Config{APIKey: os.Getenv("PASSAGE_API_KEY")}) +``` + +### Go Passwordless + +Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Go Documentation](https://docs.passage.id/complete/backend-sdks/go) page. + +## Support & Feedback + +We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md). + +
+ +--- + +

+ + + + Passage by 1Password Logo + +

+ +

+ Passage is a product by 1Password, the global leader in access management solutions with nearly 150k business customers.
+ This project is licensed under the MIT license. See the LICENSE file for more info. +

diff --git a/version.txt b/version.txt index 78e21eb..4a36d84 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -v1.11.1 \ No newline at end of file +v1.11.2 \ No newline at end of file