linly/Discord-Twitch-Live-Notifier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Migrate README from GitLab to GitHub

Browse Source
This commit is contained in:
Deko
2023-04-14 19:48:58 +02:00
parent 5c2125cde2
commit aab5c66253
1 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,7 +1,6 @@
# Discord Twitch Live Notification # Discord Twitch Live Notifier
[![pipeline status](https://gitlab.com/Deko.dev/discord-twitch-live-notifier/badges/main/pipeline.svg)](https://gitlab.com/Deko.dev/discord-twitch-live-notifier/-/commits/main) ![pipeline status](https://github.com/Gadsee/DiscordTwitchLiveNotifier/actions/workflows/pipeline.yml/badge.svg)
[![coverage report](https://gitlab.com/Deko.dev/discord-twitch-live-notifier/badges/main/coverage.svg)](https://gitlab.com/Deko.dev/discord-twitch-live-notifier/-/commits/main)
This is a python project to send a Discord webhook with a self-updating webhook This is a python project to send a Discord webhook with a self-updating webhook
when a specified streamer goes live on Twitch. when a specified streamer goes live on Twitch.
@@ -68,18 +67,18 @@ You can read up on how to install docker on the [official website](https://docs.
### Using the pre-built docker image from the registry ### Using the pre-built docker image from the registry
The pipeline builds your image into your gitlab project's docker registry at The pipeline builds your image into your GitHub project's docker registry at
`registry.gitlab.com/<YOUR USERNAME>/discord-twitch-live-notifier:main`. `ghcr.io/<YOUR USERNAME>/discordtwitchlivenotifier:main`.
In my case that's `registry.gitlab.com/dekorated/discord-twitch-live-notifier:main`. In my case that's `ghcr.io/gadsee/discordtwitchlivenotifier:main`.
You can use that to pull your image: You can use that to pull your image:
```bash ```bash
docker image pull registry.gitlab.com/dekorated/discord-twitch-live-notifier:main docker image pull ghcr.io/<YOUR USERNAME>/discordtwitchlivenotifier:main
``` ```
**Note**: If you use a private repository,you will have to `docker login registry.gitlab.com` **Note**: If you use a private repository,you will have to `docker login ghcr.io`
with your username and a gitlab access token as password first. with your username and a GitHub personal access token as password first.
Then run the image. Take note to adjust the path at `--env-file`. Then run the image. Take note to adjust the path at `--env-file`.
```bash ```bash
@@ -87,7 +86,7 @@ docker run \
--name discord-twitch-live-notifier \ --name discord-twitch-live-notifier \
--env-file /path/to/your/env-file/.env \ --env-file /path/to/your/env-file/.env \
-d \ -d \
registry.gitlab.com/dekorated/discord-twitch-live-notifier:main ghcr.io/gadsee/discordtwitchlivenotifier:main
``` ```
Your OS may treat line breaks in commands differently, please adjust accordingly. Your OS may treat line breaks in commands differently, please adjust accordingly.
The above is tested on linux/debian. The above is tested on linux/debian.
@@ -118,7 +117,7 @@ You may install the dependencies through pip, however it is recommended to insta
Clone the repository: Clone the repository:
```commandline ```commandline
git clone https://github.com/Gadsee/Discord-Twitch-Live-Notifications.git git clone https://github.com/Gadsee/DiscordTwitchLiveNotifier.git
``` ```
Install poetry (taken from the [official documentation](https://python-poetry.org/docs/)): Install poetry (taken from the [official documentation](https://python-poetry.org/docs/)):