Skip to content

Commit

Permalink
chore: update README (#36)
Browse files Browse the repository at this point in the history
Update some docs
  • Loading branch information
ascorbic authored Nov 12, 2023
1 parent 6d8df26 commit a696cea
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/semantic-prs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand All @@ -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:
Expand Down
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down

0 comments on commit a696cea

Please sign in to comment.