From 8385b9a5009a805dedf66a65bfbb85d8964d4cba Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Wed, 24 Apr 2024 22:13:00 +0700 Subject: [PATCH] docs(readme): add Example Usages section --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 4d1e430..8919780 100644 --- a/README.md +++ b/README.md @@ -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).