Skip to content

Revise README for clarity and feature updates #1241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2025
Merged

Revise README for clarity and feature updates #1241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ Inspired from https://github.com/actions/typescript-action.
## Features

- Ready to develop with the minimum configs
- Prettier
- ESLint
- tsconfig
- Jest
- Biome
- Vitest
- Automated continuous release
- Keep consistency of generated files
- Shipped with Renovate config
Expand All @@ -21,7 +20,7 @@ Click `Use this template` to create a repository.
An initial release `v0.0.0` is automatically created by GitHub Actions.
You can see the generated files in `dist` directory on the tag.

Then checkout your repository and test it. Node.js is required.
Then, checkout your repository and test it. Node.js is required.

```console
$ git clone https://github.com/your/repo.git
Expand All @@ -30,15 +29,9 @@ $ pnpm i
$ pnpm test
```

Create a pull request for a change.
Create a pull request with your change.

```console
$ git checkout -b feature
$ git commit -m 'Add feature'
$ gh pr create -fd
```

Once you merge a pull request, a new minor release (such as `v0.1.0`) is created.
After merging the pull request, a new minor release (such as `v0.1.0`) is created.

### Stable release

Expand Down