Skip to content

Commit fe720b2

Browse files
committed
docs: update the README
1 parent b277664 commit fe720b2

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ API requests efficiently using Go. The action is configured using a TOML file an
1717

1818
## Inputs
1919

20-
| Name | Description | Required | Default |
21-
|---------------|-------------------------------------|----------|----------------------------------------|
20+
| Name | Description | Required | Default |
21+
|---------------|-------------------------------------|----------|------------------------------------------------------|
2222
| `config_path` | Path to the TOML configuration file | No | `.github/configs/setup-custom-action-by-docker.toml` |
2323

2424
## Outputs
@@ -46,24 +46,27 @@ jobs:
4646
- uses: actions/checkout@v4
4747

4848
- name: Run Example GitHub Action Using Golang
49-
uses: pplmx/setup-custom-action-by-docker@v1
49+
uses: pplmx/setup-custom-action-by-docker@main
5050
```
5151
5252
You can also follow [this](.github/workflows/test_custom_action_itself.yml).
5353
5454
## Local Development
5555
56-
For instructions on setting up a local development environment and testing this GitHub Action, please refer to the [Development Documentation](docs/development.md).
56+
For instructions on setting up a local development environment and testing this GitHub Action, please refer to
57+
the [Development Documentation](docs/development.md).
5758
5859
## License
5960
6061
This project is dual-licensed under either of the following licenses, at your option:
6162
62-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
63+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)
64+
or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
6365
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
6466
6567
## Contribution
6668
67-
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
69+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as
70+
defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
6871
6972
For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)