Skip to content

docs: update readme #1209

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 2 commits into from
Jun 9, 2024
Merged

docs: update readme #1209

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce67c2e
docs: update readme
setchy Jun 9, 2024
fc5ef9b
Update README.md
setchy Jun 9, 2024
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ The release process is automated. Follow the steps below.

### Tests

There are 2 checks - one for biome (linter & formatter) and one for the unit tests with `jest`.
There are 2 checks:
1. linter & formatter with [biome][biome-website]
2. unit tests with [jest][jest-website]

```shell
# Run biome to check linting and formatting
Expand Down Expand Up @@ -75,7 +77,8 @@ Please visit our [Gitify FAQs][faqs] for all commonly asked questions.

### License

Gitify is licensed under the MIT Open Source license. For more information, see [LICENSE](LICENSE).
Gitify is licensed under the MIT Open Source license.
For more information, see [LICENSE](LICENSE).


<!-- LINK LABELS -->
Expand All @@ -89,6 +92,7 @@ Gitify is licensed under the MIT Open Source license. For more information, see
[github-website-pulls]: https://github.com/gitify-app/website/pulls
[brew]: http://brew.sh/
[homebrew-cask]: https://formulae.brew.sh/cask/gitify
[biome-website]: biomejs.dev/
[coveralls]: https://coveralls.io/github/gitify-app/gitify
[coveralls-badge]: https://img.shields.io/coverallsCoverage/github/gitify-app/gitify
[build-workflow-badge]: https://github.com/gitify-app/gitify/actions/workflows/build-app.yml/badge.svg
Expand All @@ -100,5 +104,6 @@ Gitify is licensed under the MIT Open Source license. For more information, see
[license-badge]: https://img.shields.io/github/license/gitify-app/gitify
[github-release-badge]: https://img.shields.io/github/v/release/gitify-app/gitify
[homebrew-cask-badge]: https://img.shields.io/homebrew/cask/v/gitify
[jest-website]: https://jestjs.io/
[renovate]: https://renovatebot.com/
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg