Skip to content

Commit 4064bc8

Browse files
committed
Update README
1 parent 89da62b commit 4064bc8

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,25 @@
1-
![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiOE52ek1HRWdQeW5pVmozMUNtWm1zcXBDc0FPbTFRRzZRWEhQeGFrOXd6TFFhVnlVOHQ0dWM5SHFZRnloQUFKOUY2NWdMaDBOdnMxUnYyYW9FZC9GbElNPSIsIml2UGFyYW1ldGVyU3BlYyI6ImVwQkN3WjV4MXpTZ2FXTUUiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
21
[![Patreon](https://img.shields.io/badge/support-patreon-E6461A.svg)](https://www.patreon.com/podsync)
32

3+
Podsync - is a simple, free service that lets you listen to any YouTube / Vimeo channels, playlists or user videos in podcast format.
44

5-
## Patreon
5+
Podcast applications have a rich functionality for content delivery - automatic download of new episodes, remembering last played position, sync between devices and offline listening. This functionality is not available on YouTube and Vimeo. So the aim of Podsync is to make your life easier and enable you to view/listen to content on any device in podcast client.
66

7-
In order to login via Patreon the following variables should be configured:
8-
- `PATREON_REDIRECT_URL` should point to `http://yout_host_here/patreon`
9-
- `PATREON_CLIENT_ID` and `PATREON_SECRET` should be copied from https://www.patreon.com/platform/documentation/clients
7+
## Architecture
8+
9+
![Architecture](docs/architecture.png)
1010

1111
## Building Docker images
1212

13-
Backend
14-
```bash
15-
./build.sh
16-
```
13+
Every project contains a `Makefile` for building and pushing to a registry:
1714

18-
nginx
1915
```bash
20-
./nginx.sh
16+
make build
17+
make push
18+
make update
2119
```
2220

23-
ytdl
24-
```bash
25-
cd cmd/ytdl/
26-
./build.sh
27-
```
21+
Use docker-compose to run containers:
2822

29-
## Running
3023
```bash
3124
docker-compose pull
3225
docker-compose up -d

docs/architecture.png

45.2 KB
Loading

0 commit comments

Comments
 (0)