-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Psg 4902 use repo templates #90
Changes from 3 commits
ed91b80
4cde238
d2cf94f
7b6bf5a
c6cafa2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,82 @@ | ||
# 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 | ||
|
||
<p> | ||
You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br /> | ||
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub> | ||
</p> | ||
|
||
### Install | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do these install/import/initialize steps make sense? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. made some suggestions There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated! |
||
```shell | ||
go get github.com/passageidentity/passage-go | ||
``` | ||
|
||
### Import | ||
|
||
```go | ||
import ( | ||
"net/http" | ||
|
||
"github.com/passageidentity/passage-go" | ||
) | ||
jenn-macfarlane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
### Initialize | ||
|
||
```go | ||
psg, _ := passage.New("YOUR_PASSAGE_APP_ID", nil) | ||
``` | ||
jenn-macfarlane marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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). | ||
|
||
<br /> | ||
|
||
--- | ||
|
||
<p align="center"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png"> | ||
<source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png"> | ||
<img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png"> | ||
</picture> | ||
</p> | ||
|
||
<p align="center"> | ||
<sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br /> | ||
<sub>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</sub> | ||
</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do I also need to update
version.txt
file or will that happen in CI?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes that file should be updated.
v1.11.1 was already released, but it looks like the changelog was forgotten
the overall changelog should probably be something like
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated - lmk if this looks good