Skip to content

Commit 597a469

Browse files
committed
Add some info into README
1 parent b6ee876 commit 597a469

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
11
# Setup Codee
22

33
Set up a Codee Formatter & Analyser on Linux and Windows runners.
4+
5+
- [Usage](#usage)
6+
- [Options](#options)
7+
- [Environment variables](#environment-variables)
8+
- [Runner compatibility](#runner-compatibility)
9+
- [License](#license)
10+
11+
12+
## Usage
13+
14+
```yaml
15+
jobs:
16+
test:
17+
runs-on: ${{ matrix.os }}
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
os: [ubuntu-latest, windows-latest, ubuntu-24.04-arm]
22+
23+
steps:
24+
- uses: foxtran/setup-codee@v1
25+
26+
- run: |
27+
codee format --help
28+
```
29+
30+
31+
## Options
32+
33+
- *version*: Version of the Codee tools. See [Codee Changelog](https://docs.codee.com/changelog/) to pick the latest.
34+
35+
36+
## Environment variables
37+
38+
Action updates PATH environment variable for allowing to use `codee` command.
39+
40+
41+
## Runner compatibility
42+
43+
Codee tools are available for Windows x86\_64, Linux x86\_64 and Linux AArch64 platforms.
44+
45+
46+
## License
47+
48+
Setup Codee is [MIT licensed](./LICENSE).

0 commit comments

Comments
 (0)