added guide on using local images

README.md

@@ -36,6 +36,8 @@ Simple Links is a lightweight alternative to Linktree and others.
   "name": "Your Name", // The name you want to display on the site
   "description": "A description about yourself", // The description you want to use
   "avatar": "https://cdn.fascinated.cc/KWprz2.jpg", // The avatar that is shown at the top of the site
+  // or use a local image
+  "avatar": "/avatar.png",
   "background": {
     // If you want to use a custom (not dark) background
     "showBackground": true, // Whether it is enabled or not
@@ -45,7 +47,9 @@ Simple Links is a lightweight alternative to Linktree and others.
       "enabled": true,
       "amount": 0.7
     },
-    "backgroundImage": "https://cdn.fascinated.cc/8twdW8.jpg" // The image to use in the background
+    "backgroundImage": "https://cdn.fascinated.cc/8twdW8.jpg", // The image to use in the background
+    // or use a local image
+    "backgroundImage": "/background.jpg"
   },
   "theme": "dark", // "dark" or "light" themes
   "infoCard": {

config.json

@@ -2,7 +2,7 @@
   "configVersion": "0.1.2",
   "name": "Your Name",
   "description": "A description about yourself",
-  "avatar": "https://cdn.fascinated.cc/KWprz2.jpg",
+  "avatar": "/avatar.png",
   "background": {
     "showBackground": true,
     "blur": true,
@@ -10,7 +10,7 @@
       "enabled": true,
       "amount": 0.7
     },
-    "backgroundImage": "https://cdn.fascinated.cc/8twdW8.jpg"
+    "backgroundImage": "/background.jpg"
   },
   "theme": "dark",
   "infoCard": {

docker-compose.yml

@@ -14,4 +14,5 @@ services:
     ports:
       - 3000:3000
     volumes:
-      - ./config.json:/usr/src/app/config.json:ro
+      - ./config.json:/usr/src/app/config.json:ro # The application config (Must be created before starting the service)
+      - ./public:/usr/src/app/public:ro # Used for public facing images