From a696ceabb2466d429c083848c81f4f7b03107400 Mon Sep 17 00:00:00 2001 From: Matt Kane Date: Sun, 12 Nov 2023 09:45:27 +0000 Subject: [PATCH] chore: update README (#36) Update some docs --- .github/workflows/semantic-prs.yml | 10 ++++++++++ README.md | 10 +--------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/workflows/semantic-prs.yml b/.github/workflows/semantic-prs.yml index 4808261..ddf08b7 100644 --- a/.github/workflows/semantic-prs.yml +++ b/.github/workflows/semantic-prs.yml @@ -16,6 +16,15 @@ jobs: runs-on: ubuntu-latest steps: - uses: amannn/action-semantic-pull-request@v5 + with: + types: | + fix + feat + chore + docs + ci + test + revert id: lint_pr_title env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -30,6 +39,7 @@ jobs: Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + Without this title format, a release will not be triggered Details: diff --git a/README.md b/README.md index 7587038..30c2431 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,7 @@ See the demo site for more. ### Why did you build this? -Mainly to learn, but also because there's no statically-rendered [create-react-app](https://github.com/facebook/create-react-app) equivalent. I often want a simple React site with static rendering but no SSR. Astro is awesome, but I want something that's just React. - -### Should I use this in production? - -Dear god no. It's barely alpha. +Mainly to learn, but also because there's no statically-rendered [create-react-app](https://github.com/facebook/create-react-app) equivalent. I often want a simple React site with static rendering but no SSR. Astro is awesome, but I want something that's more vanilla React. ### Does it support SSR @@ -48,10 +44,6 @@ Deliberately not. If you want SSR, use Astro. Deliberately not. If you want client-side navigation, use one of the many other SPA frameworks. -### Does it support other frontend frameworks? - -I started with React because it's the one most obviously lacking a basic SSG, but the React-specific code is in a separate package and I want to add support for other frameworks. - ## License Copyright © 2023 Matt Kane. Licenced under the MIT licence.