Psg 4895 use repo templates #85
Conversation
|
As of right now this PR is just updating the top-level README as the passage/passageflex readmes are auto-generated. Couple questions:
I'll also link to the appropriate anchor tag in the product tables in flutter/react-native where we reference Authentikit for ios/android and flex APIs. |
README.md
Outdated
| <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> | ||
|
|
||
| ### Passkey Complete |
There was a problem hiding this comment.
Like the way you broke these up! It looks like Passkey Complete is duplicated, though, and it appears twice in the README (in addition to a section for Flex and Authentikit)
There was a problem hiding this comment.
Good catch, thanks!
There was a problem hiding this comment.
Looks like there's a duplicate of Passkey Complete sections (most visible when browsing the README in the branch:
Here: https://github.com/passageidentity/passage-android/tree/PSG-4895-use-repo-templates?tab=readme-ov-file#passkey-complete
And here: https://github.com/passageidentity/passage-android/tree/PSG-4895-use-repo-templates?tab=readme-ov-file#passkey-complete-1
They are also slightly different 😅 though I think the second initialize block better aligns with our pattern :)
…tikit, passage, and passageflex and link appropriately
|
Hi @agebhardt! Thanks for the catch. I've cleaned that up, given the main README a bit of a change - namely including a "prerequisites" section under each product because they differ (either setting up Flex/Complete/either in Console). I've also added new READMEs with the same content to each individual package, and updated the product tables within each to point to the repo folder where they are found. Please take a look and let me know if I missed anything/if it makes sense this way - I've got mobile's blessing to add these. |
README.md
Outdated
|
|
||
| ### In passage-android | ||
|
|
||
| Use passage-android to implement [passage-android/passage](https://github.com/passageidentity/passage-android/passage) in your Android application to authenticate requests and manage users, [passage-android/passageflex](https://github.com/passageidentity/passage-android/passageflex) in your existing auth to use passkeys for registration, authentication, or added security on sensitive user actions, and [passage-android/authentikit](https://github.com/passageidentity/passage-android/authentikit) to gather data on your users' passkey readiness. |
There was a problem hiding this comment.
This is a mouthful but what I came up with that didn't sound super redundant given the above. Took the flex desc from passage-js-flex README. Open to suggestions!
|
|
||
| ### In passage-android/authentikit | ||
|
|
||
| Use passage-android/authentikit to implement Passkey Ready in your Android application to gather data on your users' passkey readiness. |
There was a problem hiding this comment.
Feel free to suggest an edit (should match what's in main readme).
…roid into PSG-4895-use-repo-templates
…ageidentity/passage-android into PSG-4895-use-repo-templates
|
Pull Request Template
What's New?
Uses repo templates to format README, LICENSE, and remove community files in favour of using organization community files.
Screenshots (if appropriate):
(The Passage logos will pick up theme change, this is just a screen shot from vscode):
Main README:
Complete:
Flex:
Authentikit:
Type of change
Checklist:
Jira Ticket
Please add the Jira ticket number and link.
Additional context
Add any other context or screenshots about the pull request here.