Skip to content

Commit 8ba58cf

Browse files
committed
chore: 🔧 improve documentation
1 parent 4ca30f9 commit 8ba58cf

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

‎.github/workflows/package.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on:
55
tags:
66
- '*'
77

8+
name: Build & Release Package
9+
810
jobs:
911
build-spk:
1012
name: Build Package

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ This package allows you to run GitHub Actions on your Synology NAS. It uses the
1616

1717
4. Follow the installation instructions.
1818

19-
> The package will go in error state initially, but this is expected as it needs to be elevated to run properly.
19+
**The package will go in error state initially, but this is expected as it needs to be elevated to run properly.**
2020

21-
5. Elevate the package by following the instructions in the [Elevate Package](https://github.com/tomgrv/synology-package-builder/blob/main/doc/elevated.md)
21+
5. Elevate the package by following the instructions from the [Synology Package Builder](https://github.com/tomgrv/synology-package-builder/blob/main/doc/elevated.md)
2222

2323
6. After elevation, the package will:
24-
- Download the docker image
25-
- Create a Docker container in the Container Manager
26-
- Start the GitHub Runner as configured.
24+
- Download the docker image (takes a while, you shoud receive a notification from Container Manager when done)
25+
- Create a Docker container in the Container Manager. This container will be read-only and named `github-runner`
26+
- Behave as a regular Package, allowing you to start/stop it from the Package Center.
2727

2828
## Credits
2929

@@ -34,3 +34,5 @@ This package was created using the [Synology Package Builder Github Action](http
3434
## License
3535

3636
This package is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
37+
38+
This work is not affiliated with Synology Inc. in any way. It is an independent project that aims to facilitate the development of Synology packages using GitHub Actions. It is not an official Synology product and does not have any official support from Synology Inc. Use at your own risk.

0 commit comments

Comments
 (0)