Skip to content

Commit fd4387c

Browse files
committed
docs: Update README
1 parent f2cd1f5 commit fd4387c

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Code embedder is a GitHub action that updates your README.md with up-to-date cod
99

1010
## Description
1111
This action:
12-
1. reads a README file from `readme_path` input,
13-
1. looks for specific script tags in the README,
14-
1. reads the content of the script and embeds it in the README at the corresponding tag,
12+
1. reads one or more README files from `readme_paths` input,
13+
1. looks for specific script tags in the READMEs,
14+
1. reads the content of the scripts and embeds it in the READMEs at the corresponding tags,
1515
1. pushes the changes to the repository.
1616

1717
## Workflow file structure
@@ -35,16 +35,15 @@ jobs:
3535
- name: Run code embedder
3636
uses: kvankova/[email protected]
3737
with:
38-
readme_path: README.md
38+
readme_paths: README.md README2.md
3939
env:
4040
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4141
4242
```
4343
It requires a secret `GITHUB_TOKEN` with write and repo permission.
4444

4545
## README file configuration
46-
You can specify which README file you want to update with `readme_path` (path to markdown). As of now,
47-
it supports only one readme file, and if not specified, it will by default look for it in the root `README.md`.
46+
You can specify which README files you want to update with `readme_paths` (paths to markdown files). If no README files are provided, it will by default look for it in the root `README.md`. Argument `readme_paths` accepts multiple paths separated by spaces, example: `README.md README2.md`.
4847

4948
The action looks for the following sections in the readme file based on which it will update the code snippets:
5049
````md

0 commit comments

Comments
 (0)