Update README assets

passlock-dev · Sep 4, 2024 · cef4ccb · cef4ccb
1 parent 53769ef
commit cef4ccb
Show file tree

Hide file tree

Showing 23 changed files with 108 additions and 100 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ in README.template.md and outputs to README.md
 -->
 <div align="center">
   <a href="https://github.com/passlock-dev/passlock">
-    <img src="https://github.com/passlock-dev/passkeys-frontend/assets/208345/53ee00d3-8e6c-49ea-b43c-3f901450c73b" alt="Passlock logo" width="80" height="80">
+    <img src="https://passlock-assets.b-cdn.net/images/passlock-logo.svg" alt="Passlock logo" width="80" height="80">
   </a>
 </div>
 
@@ -13,8 +13,8 @@ in README.template.md and outputs to README.md
 <a name="readme-top"></a>
 <div align="center">
   <picture align="center">
-    <source srcset="README_assets/repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
-    <img align="center" width=550 height=50 src="README_assets/repo-banner.svg" />
+    <source srcset="https://passlock-assets.b-cdn.net/images/client-repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
+    <img align="center" width=550 height=50 src="https://passlock-assets.b-cdn.net/images/client-repo-banner.svg" />
   </picture>
   <p align="center">
     Typescript library for next generation authentication. Passkeys, Apple login, Google one-tap and more..

diff --git a/README.template.md b/README.template.md
@@ -13,8 +13,8 @@ in README.template.md and outputs to README.md
 <a name="readme-top"></a>
 <div align="center">
   <picture align="center">
-    <source srcset="README_assets/repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
-    <img align="center" width=550 height=50 src="README_assets/repo-banner.svg" />
+    <source srcset="#{ASSETS_CDN}#/images/client-repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
+    <img align="center" width=550 height=50 src="#{ASSETS_CDN}#/images/client-repo-banner.svg" />
   </picture>
   <p align="center">
     Typescript library for next generation authentication. Passkeys, Apple login, Google one-tap and more..

diff --git a/package.json b/package.json
@@ -1,11 +1,11 @@
 {
   "name": "public",
   "description": "Monorepo containing the JS/TS client libraries",
-  "version": "0.9.24",
+  "version": "0.9.25",
   "private": true,
   "type": "module",
   "scripts": {
-    "build:readme": "LATEST=${npm_package_version} tsx scripts/replace-readme-tokens.ts",
+    "build:readme": "LATEST=${npm_package_version} tsx ./packages/shared/scripts/replace-readme-tokens.ts .",
     "upgrade:deps": "ncu --peer -x effect -x @effect/* -x @passlock/* -i -u && pnpm -r run upgrade:deps",
     "upgrade:pnpm": "corepack use pnpm@latest"
   },

diff --git a/packages/client/README.md b/packages/client/README.md
@@ -4,16 +4,16 @@ in README.template.md and outputs to README.md
 -->
 <div align="center">
   <a href="https://github.com/passlock-dev/passlock">
-    <img src="https://github.com/passlock-dev/passkeys-frontend/assets/208345/53ee00d3-8e6c-49ea-b43c-3f901450c73b" alt="Passlock logo" width="80" height="80">
+    <img src="https://passlock-assets.b-cdn.net/images/passlock-logo.svg" alt="Passlock logo" width="80" height="80">
   </a>
 </div>
 
 <h1 align="center">Passkeys, Social Login & More</h1>
 
 <div align="center">
   <picture align="center">
-    <source srcset="https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
-    <img align="center" width=550 height=50 src="https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/repo-banner.svg" />
+    <source srcset="https://passlock-assets.b-cdn.net/images/client-repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
+    <img align="center" width=550 height=50 src="https://passlock-assets.b-cdn.net/images/client-repo-banner.svg" />
   </picture>
   <p align="center">
     Typescript library for next generation authentication. <br/>
@@ -53,10 +53,10 @@ Passkeys and the WebAuthn API are quite complex. I've taken an opinionated appro
 
 ## Screenshots
 
-![SvelteKit template using this library](https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/preline.dark.png)
+![SvelteKit template using this library](https://passlock-assets.b-cdn.net/images/preline.dark.png)
 <p align="center">Demo app using this library for passkey and social login</p>
 
-![Passlock user profile](https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/console.png)
+![Passlock user profile](https://passlock-assets.b-cdn.net/images/console.png)
 <p align="center">Viewing a user's authentication activity on their profile page</p>
 
 ## Usage

diff --git a/packages/client/README.template.md b/packages/client/README.template.md
@@ -12,8 +12,8 @@ in README.template.md and outputs to README.md
 
 <div align="center">
   <picture align="center">
-    <source srcset="https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
-    <img align="center" width=550 height=50 src="https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/repo-banner.svg" />
+    <source srcset="#{ASSETS_CDN}#/images/client-repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
+    <img align="center" width=550 height=50 src="#{ASSETS_CDN}#/images/client-repo-banner.svg" />
   </picture>
   <p align="center">
     Typescript library for next generation authentication. <br/>
@@ -53,10 +53,10 @@ Passkeys and the WebAuthn API are quite complex. I've taken an opinionated appro
 
 ## Screenshots
 
-![SvelteKit template using this library](https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/preline.dark.png)
+![SvelteKit template using this library](#{ASSETS_CDN}#/images/preline.dark.png)
 <p align="center">Demo app using this library for passkey and social login</p>
 
-![Passlock user profile](https://raw.githubusercontent.com/passlock-dev/ts-clients/master/README_assets/console.png)
+![Passlock user profile](#{ASSETS_CDN}#/images/console.png)
 <p align="center">Viewing a user's authentication activity on their profile page</p>
 
 ## Usage

diff --git a/packages/client/package.json b/packages/client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@passlock/client",
-  "version": "0.9.24",
+  "version": "0.9.25",
   "description": "Passkey authentication and social login for web apps (Typescript). Framework agnostic",
   "keywords": [
     "passkey",
@@ -24,11 +24,11 @@
   "homepage": "https://passlock.dev",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/passlock-dev/ts-clients.git",
+    "url": "git+https://github.com/passlock-dev/passlock.git",
     "directory": "packages/client"
   },
   "bugs": {
-    "url": "https://github.com/passlock-dev/ts-clients/issues",
+    "url": "https://github.com/passlock-dev/passlock/issues",
     "email": "[email protected]"
   },
   "type": "module",

diff --git a/packages/create-sveltekit/README.md b/packages/create-sveltekit/README.md
@@ -4,16 +4,16 @@ in README.template.md and outputs to README.md
 -->
 <div align="center">
   <a href="https://github.com/passlock-dev/passlock">
-    <img src="https://github.com/passlock-dev/passkeys-frontend/assets/208345/53ee00d3-8e6c-49ea-b43c-3f901450c73b" alt="Passlock logo" width="80" height="80">
+    <img src="https://passlock-assets.b-cdn.net/images/passlock-logo.svg" alt="Passlock logo" width="80" height="80">
   </a>
 </div>
 
 <div>
-  <h1 align="center">SvelteKit authentication starter app</h1>
+  <h1 align="center">SvelteKit starter app</h1>
   <p align="center">
-    Sveltekit starter template featuring Passkeys, Social Login (Apple & Google) and more...
+    Sveltekit starter template featuring Passkeys, Social Login (Apple & Google), CRUD operations and more...
     <br />
-    <a href="https://github.com/passlock-dev/passlock/blob/master/packages/create-sveltekit/docs/README.md"><strong>Project website »</strong></a>
+    <a href="https://github.com/passlock-dev/passlock/tree/master/packages/create-sveltekit/docs"><strong>Project website »</strong></a>
     <br />
     <a href="https://github.com/passlock-dev/passlock">GitHub</a>
     ·
@@ -30,12 +30,12 @@ in README.template.md and outputs to README.md
 ## Features
 
 1. 🔑 Passkey registration and authentication
-2. 📱 Apple sign in
-3. ☝️ Google sign in / one-tap
+2. 📱 [Apple sign in][apple-sign-in]
+3. ☝️ [Google sign in][google-sign-in] / one-tap
 4. 📪 Mailbox verification (via a one time code or link)
-5. 💾 CRUD operations via Prisma
+5. 💾 CRUD operations via [Prisma][prisma]
 6. 🌘 Dark mode with theme selection (light/dark/system)
-7. 🚀 Daisy UI, Preline & Shadcn/UI variants
+7. 🚀 [Daisy UI][daisy], [Preline UI][preline] & [Shadcn/UI][shadcn] variants
 
 ## Requirements
 
@@ -47,7 +47,7 @@ Create an account at [https://passlock.dev][passlock-signup]
 
 ## Usage
 
-Use this CLI to create a SvelteKit app. Choose from [Preline CSS][preline] or [Shadcn/ui][shadcn] variants
+Use the CLI to create a SvelteKit app. Choose from [Daisy][daisy], [Preline][preline] or [Shadcn][shadcn] variants
 
 ```bash
 pnpm create @passlock/sveltekit
@@ -82,7 +82,10 @@ Please see the template [homepage][homepage]
 [passlock-settings]: https://console.passlock.dev/settings
 [passlock-apikeys]: https://console.passlock.dev/apikeys
 [pnpm]: https://pnpm.io/installation
-[preline]: https://preline.co
+[apple-sign-in]: https://developer.apple.com/sign-in-with-apple/
+[google-sign-in]: https://developers.google.com/identity/gsi/web/guides/overview
+[prisma]: https://www.prisma.io/orm
 [daisy]: https://daisyui.com
+[preline]: https://preline.co
 [shadcn]: https://www.shadcn-svelte.com
-[homepage]: https://github.com/passlock-dev/ts-clients/packages/create-sveltekit/docs/README.md
+[homepage]: https://github.com/passlock-dev/passlock/tree/master/packages/create-sveltekit/docs
diff --git a/packages/create-sveltekit/README.template.md b/packages/create-sveltekit/README.template.md
@@ -9,11 +9,11 @@ in README.template.md and outputs to README.md
 </div>
 
 <div>
-  <h1 align="center">SvelteKit authentication starter app</h1>
+  <h1 align="center">SvelteKit starter app</h1>
   <p align="center">
-    Sveltekit starter template featuring Passkeys, Social Login (Apple & Google) and more...
+    Sveltekit starter template featuring Passkeys, Social Login (Apple & Google), CRUD operations and more...
     <br />
-    <a href="#{GITHUB_REPO}#/blob/master/packages/create-sveltekit/docs/README.md"><strong>Project website »</strong></a>
+    <a href="#{GITHUB_REPO}#/tree/master/packages/create-sveltekit/docs"><strong>Project website »</strong></a>
     <br />
     <a href="#{GITHUB_REPO}#">GitHub</a>
     ·
@@ -30,12 +30,12 @@ in README.template.md and outputs to README.md
 ## Features
 
 1. 🔑 Passkey registration and authentication
-2. 📱 Apple sign in
-3. ☝️ Google sign in / one-tap
+2. 📱 [Apple sign in][apple-sign-in]
+3. ☝️ [Google sign in][google-sign-in] / one-tap
 4. 📪 Mailbox verification (via a one time code or link)
-5. 💾 CRUD operations via Prisma
+5. 💾 CRUD operations via [Prisma][prisma]
 6. 🌘 Dark mode with theme selection (light/dark/system)
-7. 🚀 Daisy UI, Preline & Shadcn/UI variants
+7. 🚀 [Daisy UI][daisy], [Preline UI][preline] & [Shadcn/UI][shadcn] variants
 
 ## Requirements
 
@@ -47,7 +47,7 @@ Create an account at [https://passlock.dev][passlock-signup]
 
 ## Usage
 
-Use this CLI to create a SvelteKit app. Choose from [Preline CSS][preline] or [Shadcn/ui][shadcn] variants
+Use the CLI to create a SvelteKit app. Choose from [Daisy][daisy], [Preline][preline] or [Shadcn][shadcn] variants
 
 ```bash
 pnpm create @passlock/sveltekit
@@ -82,7 +82,10 @@ Please see the template [homepage][homepage]
 [passlock-settings]: https://console.passlock.dev/settings
 [passlock-apikeys]: https://console.passlock.dev/apikeys
 [pnpm]: https://pnpm.io/installation
-[preline]: https://preline.co
+[apple-sign-in]: https://developer.apple.com/sign-in-with-apple/
+[google-sign-in]: https://developers.google.com/identity/gsi/web/guides/overview
+[prisma]: https://www.prisma.io/orm
 [daisy]: https://daisyui.com
+[preline]: https://preline.co
 [shadcn]: https://www.shadcn-svelte.com
-[homepage]: https://github.com/passlock-dev/ts-clients/packages/create-sveltekit/docs/README.md
+[homepage]: #{GITHUB_REPO}#/tree/master/packages/create-sveltekit/docs
diff --git a/packages/create-sveltekit/docs/README.md b/packages/create-sveltekit/docs/README.md
@@ -4,7 +4,7 @@ in README.template.md and outputs to README.md
 -->
 <div align="center">
   <a href="https://github.com/passlock-dev/passlock">
-    <img src="https://github.com/passlock-dev/passkeys-frontend/assets/208345/53ee00d3-8e6c-49ea-b43c-3f901450c73b" alt="Passlock logo" width="80" height="80">
+    <img src="https://passlock-assets.b-cdn.net/images/passlock-logo.svg" alt="Passlock logo" width="80" height="80">
   </a>
 </div>
 
@@ -13,8 +13,8 @@ in README.template.md and outputs to README.md
 <h1 align="center">SvelteKit Starter App</h1>
 <div align="center">
   <picture align="center">
-    <source srcset="assets/repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
-    <img align="center" width=550 height=50 src="assets/repo-banner.svg" />
+    <source srcset="https://passlock-assets.b-cdn.net/images/client-repo-banner.dark.svg" media="(prefers-color-scheme: dark)" />
+    <img align="center" width=550 height=50 src="https://passlock-assets.b-cdn.net/images/client-repo-banner.svg" />
   </picture>
 </div>
 <p align="center">
@@ -26,12 +26,12 @@ in README.template.md and outputs to README.md
 ## Features
 
 1. 🔑 Passkey registration and authentication
-2. 📱 Apple sign in
-3. ☝️ Google sign in / one-tap
+2. 📱 [Apple sign in][apple-sign-in]
+3. ☝️ [Google sign in][google-sign-in] / one-tap
 4. 📪 Mailbox verification (via a one time code or link)
-5. 💾 CRUD operations via Prisma
+5. 💾 CRUD operations via [Prisma][prisma]
 6. 🌘 Dark mode with theme selection (light/dark/system)
-7. 🚀 Daisy UI, Preline & Shadcn/UI variants
+7. 🚀 [Daisy UI][daisy], [Preline][preline] & [Shadcn/UI][shadcn] variants
 
 ## Screenshots
 
@@ -41,7 +41,7 @@ in README.template.md and outputs to README.md
 
 <br />
 
-![Shadcn/ui variant](./assets/shadcn.webp)
+![Shadcn/UI variant](./assets/shadcn.webp)
 
 <p align="center">Shadcn/ui variant (dark mode)</p>
 
@@ -53,8 +53,8 @@ in README.template.md and outputs to README.md
 4. [Prisma ORM][prisma] - Typescript ORM
 5. [Tailwind][tailwind] - Utility-first CSS framework
 6. [Daisy UI][daisy] = Tailwind UI library
-7. [Preline][preline] - Tailwind UI library <sup>1</sup>
-8. [shadcn][shadcn] - Tailwind components for Svelte
+7. [Preline UI][preline] - Tailwind UI library <sup>1</sup>
+8. [Shadcn UI][shadcn] - Tailwind components for Svelte
 9. [Melt UI][meltui] - Headless component library for Svelte
 
 <sup>[1]</sup> Uses native Svelte in place of Preline JavaScript  
@@ -71,7 +71,7 @@ Create an account at [https://passlock.dev][passlock-signup]
 
 ## Usage
 
-Use the CLI to create a SvelteKit app. Choose from [Preline CSS][preline] or [Shadcn/ui][shadcn] variants
+Use the CLI to create a SvelteKit app. Choose from [Daisy][daisy], [Preline][preline] or [Shadcn][shadcn] variants
 
 ```bash
 pnpm create @passlock/sveltekit
@@ -140,7 +140,7 @@ This template also supports Social Login from both Apple and Google..
 
 ## Sign in with Google
 
-Allow your users to register/sign in using a Google account. The app uses the latest [sign in with google][google-signin] code, avoiding redirects.
+Allow your users to register/sign in using a Google account. The app uses the latest [sign in with google][google-sign-in] code, avoiding redirects.
 
 ### Adding Google sign in
 
@@ -189,7 +189,7 @@ If all went well you should be able to register an account and sign in using you
 
 This app also supports mailbox verification emails (via Passlock):
 
-![Verifying mailbox ownership](https://github.com/passlock-dev/svelte-passkeys/assets/208345/2f7c06d6-c2a9-40f2-a8db-0a44fa378281)
+![Verifying mailbox ownership](https://passlock-assets.b-cdn.net/images/verify-mailbox.png)
 
 You can choose to verify an email address during passkey registration. Take a look at `src/routes/(other)/+page.svelte`:
 
@@ -224,18 +224,19 @@ Please file an [issue][issues] and I'll respond ASAP.
 [passlock]: https://passlock.dev
 [lucia]: https://lucia-auth.com
 [tailwind]: https://tailwindcss.com
-[preline]: https://preline.co
-[daisy]: https://daisyui.com
-[prisma]: https://www.prisma.io/orm
 [meltui]: https://melt-ui.com
-[shadcn]: https://www.shadcn-svelte.com
 [passlock-signup]: https://console.passlock.dev/register
 [passlock-console]: https://console.passlock.dev
 [passlock-settings]: https://console.passlock.dev/settings
 [passlock-apikeys]: https://console.passlock.dev/apikeys
-[google-signin]: https://developers.google.com/identity/gsi/web/guides/overview
 [google-client-id]: https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid#get_your_google_api_client_id
-[issues]: https://github.com/passlock-dev/svelte-passkeys/issues
+[issues]: https://github.com/passlock-dev/passlock/issues
 [superforms]: https://superforms.rocks
 [apple-verification-codes]: https://www.cultofmac.com/819421/ios-17-autofill-verification-codes-safari-mail-app/
 [google-passkeys]: https://safety.google/authentication/passkey/
+[apple-sign-in]: https://developer.apple.com/sign-in-with-apple/
+[google-sign-in]: https://developers.google.com/identity/gsi/web/guides/overview
+[prisma]: https://www.prisma.io/orm
+[daisy]: https://daisyui.com
+[preline]: https://preline.co
+[shadcn]: https://www.shadcn-svelte.com