Skip to content

Commit 46b2063

Browse files
committed
Improve documentation
1 parent 01d34ab commit 46b2063

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

DEVELOPMENT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Development
2+
3+
After you've cloned the repository to your local machine, install the
4+
dependencies:
5+
6+
```shell
7+
npm install
8+
```
9+
10+
To package the action for distribution after making the changes to the
11+
TypeScript code, run the following command:
12+
13+
```shell
14+
npm run bundle
15+
```

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# SwiftLint Action
1+
Run [SwiftLint](https://github.com/realm/SwiftLint) from your GitHub Actions with ease and annotations.
22

3-
Run SwiftLint from your GitHub Actions with ease.
3+
Works with GitHub-managed runners, self-hosted runners and runners from services like [Cirrus Runners](https://cirrus-runners.app/).
44

55
## Usage
66

@@ -10,19 +10,3 @@ steps:
1010
with:
1111
version: latest
1212
```
13-
14-
## Development
15-
16-
After you've cloned the repository to your local machine, install the
17-
dependencies:
18-
19-
```shell
20-
npm install
21-
```
22-
23-
To package the action for distribution after making the changes to the
24-
TypeScript code, run the following command:
25-
26-
```shell
27-
npm run bundle
28-
```

0 commit comments

Comments
 (0)