Improve documentation

cirruslabs · May 15, 2024 · 46b2063 · 46b2063
1 parent 01d34ab
commit 46b2063
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 18 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,15 @@
+## Development
+
+After you've cloned the repository to your local machine, install the
+dependencies:
+
+```shell
+npm install
+```
+
+To package the action for distribution after making the changes to the
+TypeScript code, run the following command:
+
+```shell
+npm run bundle
+```
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# SwiftLint Action
+Run [SwiftLint](https://github.com/realm/SwiftLint) from your GitHub Actions with ease and annotations.
 
-Run SwiftLint from your GitHub Actions with ease.
+Works with GitHub-managed runners, self-hosted runners and runners from services like [Cirrus Runners](https://cirrus-runners.app/).
 
 ## Usage
 
@@ -10,19 +10,3 @@ steps:
     with:
       version: latest
 ```
-
-## Development
-
-After you've cloned the repository to your local machine, install the
-dependencies:
-
-```shell
-npm install
-```
-
-To package the action for distribution after making the changes to the
-TypeScript code, run the following command:
-
-```shell
-npm run bundle
-```