Skip to content

Commit 15328a7

Browse files
committed
update docs
1 parent 3ad5f55 commit 15328a7

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

README.md

+70-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@
88
> SCM engine can be run either as a regular CI job in your pipeline, or be triggered through the Webhook system, allowing for versatile and flexible deployments.
99
1010
- [Installation](#installation)
11+
- [Docker](#docker)
12+
- [homebrew tap](#homebrew-tap)
13+
- [apt](#apt)
14+
- [yum](#yum)
15+
- [snapcraft](#snapcraft)
16+
- [scoop](#scoop)
17+
- [aur](#aur)
18+
- [deb, rpm and apk packages](#deb-rpm-and-apk-packages)
19+
- [go install](#go-install)
20+
- [Usage](#usage)
21+
- [GitLab-CI pipeline](#gitlab-ci-pipeline)
1122
- [Commands](#commands)
1223
- [`evaluate`](#evaluate)
1324
- [Configuration file](#configuration-file)
@@ -42,7 +53,65 @@
4253

4354
## Installation
4455

45-
TODO
56+
### Docker
57+
58+
```shell
59+
docker run --rm ghcr.io/jippi/scm-engine
60+
```
61+
62+
### homebrew tap
63+
64+
```shell
65+
brew install jippi/tap/scm-engine
66+
```
67+
68+
### apt
69+
70+
```shell
71+
echo 'deb [trusted=yes] https://pkg.jippi.dev/apt/ * *' | sudo tee /etc/apt/sources.list.d/scm-engine.list
72+
sudo apt update
73+
sudo apt install scm-engine
74+
```
75+
76+
### yum
77+
78+
```shell
79+
echo '[scm-engine]
80+
name=scm-engine
81+
baseurl=https://pkg.jippi.dev/yum/
82+
enabled=1
83+
gpgcheck=0' | sudo tee /etc/yum.repos.d/scm-engine.repo
84+
sudo yum install scm-engine
85+
```
86+
87+
### snapcraft
88+
89+
```shell
90+
sudo snap install scm-engine
91+
```
92+
93+
### scoop
94+
95+
```shell
96+
scoop bucket add scm-engine https://github.com/jippi/scoop-bucket.git
97+
scoop install scm-engine
98+
```
99+
100+
### aur
101+
102+
```shell
103+
yay -S scm-engine-bin
104+
```
105+
106+
### deb, rpm and apk packages
107+
108+
Download the `.deb`, `.rpm` or `.apk` packages from the [releases page](https://github.com/jippi/scm-engine/releases) and install them with the appropriate tools.
109+
110+
### go install
111+
112+
```shell
113+
go install github.com/jippi/scm-engine/cmd@latest
114+
```
46115

47116
## Usage
48117

0 commit comments

Comments
 (0)