From 9f6e8df16789785f2dbc0d518c648d22581f5e3d Mon Sep 17 00:00:00 2001 From: scosman Date: Sun, 21 Jul 2024 07:01:40 -0400 Subject: [PATCH] Improve readme: fixed links, local misspell --- README.md | 5 ++++- src/routes/(marketing)/+page.svelte | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 760bc932..03d1adad 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,9 @@ npm run lint npm run build npm run check npm run test_run + +# Optional: check for misspelled words. Uncomment line below after installing misspell tool https://github.com/client9/misspell?tab=readme-ov-file#install +# misspell -error ./src README.md ``` Finally: if you find build, formatting or linting rules too tedious, you can disable enforcement by deleting the CI files (`.github/workflows/*`) and remove the git hook (`.git/hooks/pre-commit`). @@ -301,7 +304,7 @@ These extensions are reference implementations of commonly needed features. We d - Internationalization: [branch](https://github.com/CriticalMoments/CMSaasStarter/tree/extension/internationalization), and [instructions](https://github.com/CriticalMoments/CMSaasStarter/pull/49) - Dark mode theme: [branch](https://github.com/CriticalMoments/CMSaasStarter/tree/extension/dark_mode), and [instructions](https://github.com/CriticalMoments/CMSaasStarter/pull/47) -## Icons +### Icons Credits Homescreen Icons are from [Solar Broken Line Icons](https://www.svgrepo.com/collection/solar-broken-line-icons/) and [Solar Linear Icons](https://www.svgrepo.com/collection/solar-linear-icons) via CC Attribution License. diff --git a/src/routes/(marketing)/+page.svelte b/src/routes/(marketing)/+page.svelte index 689ff3ae..64c07dd8 100644 --- a/src/routes/(marketing)/+page.svelte +++ b/src/routes/(marketing)/+page.svelte @@ -20,7 +20,7 @@ name: "Free to host", description: "Instructions included for Cloudflare+Supabase. Free to start, and cost effective to scale.", - link: "https://github.com/CriticalMoments/CMSaasStarter/blob/main/README.md#pricing", + link: "https://github.com/CriticalMoments/CMSaasStarter?tab=readme-ov-file#suggested-hosting-stack", linkText: "Docs", newPage: true, svgContent: ` @@ -152,7 +152,7 @@ "Built in linting, type checking, formatting, and test framework. Run locally in your editor, and on Github CI.", newPage: true, linkText: "Docs", - link: "https://github.com/CriticalMoments/CMSaasStarter?tab=readme-ov-file#developer-environment", + link: "https://github.com/CriticalMoments/CMSaasStarter?tab=readme-ov-file#developer-tools", svgContent: ` @@ -181,7 +181,7 @@ "Community extensions for internationalization, dark mode theme, and more.", linkText: "Docs", newPage: true, - link: "https://github.com/CriticalMoments/CMSaasStarter?tab=readme-ov-file#extensions", + link: "https://github.com/CriticalMoments/CMSaasStarter?tab=readme-ov-file#community-extensions", svgContent: `