Skip to content

Commit

Permalink
docs(readme): add Example Usages section
Browse files Browse the repository at this point in the history
  • Loading branch information
threeal committed Apr 24, 2024
1 parent 1582af3 commit 8385b9a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,26 @@ Compile and test solutions to [LeetCode](https://leetcode.com/) problems on GitH
| ------- | ---------------- | ---------------------------------------------------------------------------------- |
| `files` | Multiple strings | A list of pattern for solution files to process. It defaults to `**/solution.cpp`. |

## Example Usages

This example demonstrates how to use this action to compile and test solutions to LeetCode problems in a GitHub Actions workflow:

```yaml
name: Test
on:
push:
jobs:
test-solutions:
name: Test Solutions
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.2e

- name: Test Solutions
uses: threeal/leettest-action@v0.2.0
```
## License
This project is licensed under the terms of the [MIT License](./LICENSE).
Expand Down

0 comments on commit 8385b9a

Please # to comment.