Skip to content

Commit daf1b77

Browse files
committed
docs: update README
1 parent 66cdd27 commit daf1b77

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This is a template for creating Android Open Source libraries. This template fea
99
- :package: Dependency management with Version Catalogue
1010
- :memo: CHANGELOG following a keepchangelog.com format
1111
- :wrench: Gradle Convention Plugins for consistent build configuration across modules
12+
- 🌐GH pages to host the documentation
1213

1314
## Table of Contents
1415
- [Usage](#usage)
@@ -89,6 +90,11 @@ The Dokka plugin is applied to the library module and generates KDocks documenta
8990
library. The generated documentation is published together with the project documentation and can be
9091
accessed using github pages.
9192

93+
### Github Pages
94+
Every push to the `main` branch triggers the `Generate Docs` workflow that will generate the documentation and
95+
publish it to the `gh-pages` branch. The documentation can be accessed using the following link:
96+
`https://<username>.github.io/<repository-name>/`
97+
9298

9399
## Contributing
94100
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

0 commit comments

Comments
 (0)