Skip to content

Commit d6da06a

Browse files
committed
docs: improve readme
1 parent e0dae7f commit d6da06a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# ghapp
2-
3-
[![ci](https://github.com/jhagestedt/ghapp/actions/workflows/ci.yml/badge.svg)](https://github.com/jhagestedt/ghapp/actions/workflows/ci.yml)
1+
# `ghapp --help`
42

53
Lightweight `CLI` to create GitHub installation tokens for GitHub Apps.
64

7-
## Install
5+
[![ci](https://github.com/jhagestedt/ghapp/actions/workflows/ci.yml/badge.svg)](https://github.com/jhagestedt/ghapp/actions/workflows/ci.yml)
6+
7+
## 🚀 Install
88

99
The packaged binaries of `ghapp` can be found on the [releases](https://github.com/jhagestedt/ghapp/releases) of this repository.
1010

11-
### Linux
11+
### 🐧 Linux
1212

1313
```bash
1414
curl -L "https://github.com/jhagestedt/ghapp/releases/latest/download/ghapp_linux_amd64" \
1515
-o ./ghapp && chmod +x ./ghapp
1616
```
1717

18-
### MacOS
18+
### 🍏 MacOS
1919

2020
```bash
2121
curl -L "https://github.com/jhagestedt/ghapp/releases/latest/download/ghapp_darwin_amd64" \
2222
-o ./ghapp && chmod +x ./ghapp
2323
```
2424

25-
## Usage
25+
## 🧑‍💻 Usage
2626

2727
A GitHub App installation token can be created by the GitHub App id, the installation id and the private key like described in the [docs](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps).
2828

@@ -56,7 +56,7 @@ A usage on GitHub Actions could look like the following.
5656
GHAPP_PRIVATE_KEY: ${{ secrets.GHAPP_PRIVATE_KEY }}
5757
```
5858
59-
## Docker
59+
## 🐳 Docker
6060
6161
There is also a docker container published at [Dockerhub](https://hub.docker.com/repository/docker/jhagestedt/ghapp) that contains the binary that can be used with `docker run` to not install it locally.
6262

0 commit comments

Comments
 (0)