Updated README.
All checks were successful
Gitea - Public/reddit-slideshow/pipeline/head This commit looks good
All checks were successful
Gitea - Public/reddit-slideshow/pipeline/head This commit looks good
This commit is contained in:
parent
1cbd262964
commit
f4c4345893
40
README.md
40
README.md
@ -1,8 +1,48 @@
|
|||||||
# reddit-slideshow
|
# reddit-slideshow
|
||||||
|
|
||||||
Site that displays a slideshow with images/gifs obtained from reddit. By default images will be fetched from reddit frontpage.
|
Site that displays a slideshow with images/gifs obtained from reddit. By default images will be fetched from reddit frontpage.
|
||||||
|
|
||||||
Currently hosted at https://redditslideshow.com/
|
Currently hosted at https://redditslideshow.com/
|
||||||
|
|
||||||
|
## Additional Info
|
||||||
|
|
||||||
|
My contribution to this is:
|
||||||
|
|
||||||
|
- Serving the application through a Docker image.
|
||||||
|
- Added a basic landing page with easy to access links for specific slideshows.
|
||||||
|
|
||||||
|
### Hosting with Docker
|
||||||
|
|
||||||
|
You can base yourself off this `docker-compose.yml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: "3.9"
|
||||||
|
|
||||||
|
services:
|
||||||
|
service:
|
||||||
|
image: code.moonstar-x.dev/public/reddit-slideshow:latest
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- ./settings.json:/usr/share/nginx/html/settings.json
|
||||||
|
ports:
|
||||||
|
- 8080:8080
|
||||||
|
environment:
|
||||||
|
- TZ=America/Guayaquil
|
||||||
|
```
|
||||||
|
|
||||||
|
The `settings.json` file should contain something like this:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"slideshows": [
|
||||||
|
"funny",
|
||||||
|
["memes", "pics"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Single subreddits are strings whereas multireddits are arrays.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
You can go to the previous/next slide by pressing `A` or `D` respectively, or by using the arrow keys.
|
You can go to the previous/next slide by pressing `A` or `D` respectively, or by using the arrow keys.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user