Merge pull request #1 from rameskum/main-1

feat(README): Enhance README with Docker instructions
This commit is contained in:
Ramesh Kumar 2024-10-01 08:56:50 +10:00 committed by GitHub
commit 74bb83f6b2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 2 deletions

10
Dockerfile Normal file
View file

@ -0,0 +1,10 @@
FROM --platform=${BUILDPLATFORM} python:3.9.20-slim-bookworm
RUN pip install aiohttp
VOLUME /app/downloads
WORKDIR /app
COPY mkbsd.py .
CMD ["python", "mkbsd.py"]

View file

@ -1,12 +1,12 @@
```
/$$ /$$ /$$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$$
/$$ /$$ /$$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$$
| $$$ /$$$| $$ /$$/| $$__ $$ /$$__ $$| $$__ $$
| $$$$ /$$$$| $$ /$$/ | $$ \ $$| $$ \__/| $$ \ $$
| $$ $$/$$ $$| $$$$$/ | $$$$$$$ | $$$$$$ | $$ | $$
| $$ $$$| $$| $$ $$ | $$__ $$ \____ $$| $$ | $$
| $$\ $ | $$| $$\ $$ | $$ \ $$ /$$ \ $$| $$ | $$
| $$ \/ | $$| $$ \ $$| $$$$$$$/| $$$$$$/| $$$$$$$/
|__/ |__/|__/ \__/|_______/ \______/ |_______/
|__/ |__/|__/ \__/|_______/ \______/ |_______/
```
_Because selling out is bad_
@ -30,6 +30,12 @@ MKBSD comes in two variants! Node.js and Python.
4. Wait a little.
5. All wallpapers are now in a newly created `downloads` subfolder.
### Running using docker
1. Ensure you have docker installed
2. Build the image with `docker build -t mkbsd .`
3. Run the image, mounting a directory where you want the image to be stored as a volume at `/app/downloads`. For example, `docker run -v $PWD:/app/downloads mkbsd`
## FAQ
### Q: What's the story behind this?