Skip to content

Commit

Permalink
Improved Docs (#9)
Browse files Browse the repository at this point in the history
* Improve documentation

* Update README.md

* Full example
  • Loading branch information
fkorotkov authored May 15, 2024
1 parent 091cfed commit 025a084
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 15 deletions.
15 changes: 15 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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
```
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# 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.
<img width="1010" alt="SwiftLintDemoPR" src="https://github.com/cirruslabs/swiftlint-action/assets/989066/70f99351-4889-4a72-bbbf-e6cc9ab9b25f">

Works with GitHub-managed runners, self-hosted runners and runners from services
like [Cirrus Runners](https://cirrus-runners.app/).

## Usage

Expand All @@ -11,18 +15,24 @@ steps:
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:
Here is a full example of a workflow file:
```shell
npm run bundle
```yaml
# .github/workflows/swiftlint.yml
name: SwiftLint

on:
push:
branches: ['main']
pull_request:
branches: ['main']

jobs:
SwiftLint:
runs-on: ghcr.io/cirruslabs/macos-runner:sonoma
steps:
- uses: actions/checkout@v4
- uses: cirruslabs/swiftlint-action@v1
with:
version: latest
```

0 comments on commit 025a084

Please sign in to comment.