Skip to content

Commit

Permalink
docs: Describe the purpose of this repo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
f-hollow committed Apr 7, 2024
1 parent 339d683 commit ae3f62a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

[![.github/workflows/dynamic-template.yml](https://github.com/f-hollow/demo-action-dynamic-readme/actions/workflows/dynamic-template.yml/badge.svg)](https://github.com/f-hollow/demo-action-dynamic-readme/actions/workflows/dynamic-template.yml)

This repo contains some workflows to update README.

- `update-readme.yml` appends data from a file to README and commits it. This is a very simple workflow created as a proof of concept. It needs many improvements to be useful, such as replacing actual markers instead of appending the same data over and over.
- `.github/workflows/dynamic-template.yml` is a third-party solution called [Dynamic Readme](https://github.com/marketplace/actions/dynamic-readme) to make READMEs "dynamic". It works but it seems like the project is not actively maintained. The table below is replaced with a new one from `templates/tables/table.md` on every push.

<!-- START ./tables/table.md -->
| One | Two | Three |
| --- | --- | --- |
Expand Down

0 comments on commit ae3f62a

Please sign in to comment.