Skip to content

Commit fd0c968

Browse files
authored
Fix typos and enhance README usage section
Corrected typos and improved clarity in usage instructions.
1 parent 87a42e8 commit fd0c968

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
This library provides an easy way to display a change log in your app.
99
Without take care to VersionCode is necessary when you auto generate the VersionCode
1010

11-
## Usage manuel XML
11+
## Usage of a XML
1212

1313
1. Create the master change log in `res/xml/changelog_master.xml`. Formatted like this:
1414

@@ -32,14 +32,14 @@ Without take care to VersionCode is necessary when you auto generate the Version
3232
language-specific versions of `res/xml/`, e.g. `res/xml-de/changelog.xml`.
3333

3434
## Usage git changelog
35-
To generate a git changelog, grouped by tag you can run `getTagGroupedGitlog` e.g
35+
To generate a git changelog, grouped by tag you can run `getTagGroupedGitlog` `from git submodule buildSrc/src/main/kotlin/info/git/versionHelper`
36+
This will automatic generate a changelog based on git history, grouped by tags.
3637

3738
```kts
3839
afterEvaluate {
3940
tasks.named("generateReleaseResources") {
4041
doLast {
4142
getTagGroupedGitlog(
42-
verbose = true,
4343
filter = "RELEASE", // optional, only include tags with "RELEASE" in their name
4444
filename = "app/src/main/res/raw/gitlog.json"
4545
)

0 commit comments

Comments
 (0)