Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
levinzonr committed May 23, 2024
1 parent e68a59b commit fb9e2da
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is a template for creating Android Open Source libraries. This template fea
- πŸ” Code Quality checks with Detekt, Spotless and Tests
- πŸ“• Documentation setup with Dokka and MkDocs
- πŸ“¦ Dependency management with Version Catalogue
- πŸ“ CHANGELOG following a keepchangelog.com format
- πŸ“ CHANGELOG following a keepchangelog.com format and JetBrains Changelog Plugin to accompany the release notes
- πŸ”§ Gradle Convention Plugins for consistent build configuration across modules
- 🌐 GH pages to host the documentation

Expand Down Expand Up @@ -75,8 +75,7 @@ to the Maven Central.

This template follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for
changelog entries. The changelog is stored in the `CHANGELOG.md` file.
When Draft Release is created, the script `get_changelog.sh`
will be executed to update the release notes with the latest changes according
When Draft Release is created, the Changelog plugin from Jetbrains to update the release notes with the latest changes according
to the latest version specified in the `gradle.properties` file.

## Documentation
Expand Down Expand Up @@ -110,4 +109,5 @@ Please make sure to update tests as appropriate.
- [GitHub Actions](https://docs.github.com/en/actions)
- [Detekt](https://detekt.github.io/detekt/)
- [Spotless](https://github.com/diffplug/spotless)
- [Changelog Plugin](https://github.com/JetBrains/gradle-changelog-plugin)

0 comments on commit fb9e2da

Please sign in to comment.