comments and readme updated

Author: scriptPilot

.gitignore

@@ -1,8 +1,8 @@
-# System Files
+# Exclude system files
 .DS_Store
 
-# NPM Modules
+# Exclude Node modules
 node_modules/
 
-# Environment Variables File
+# Exclude the environment variables
 .env

Dockerfile

@@ -1,20 +1,20 @@
-# User lightwight base image
+# Use a lightweight base image
 FROM node:20.9.0-alpine
 
 # Install Git
 RUN apk add --no-cache git
 
-# Define work directory
+# Define the work directory
 WORKDIR /usr/src/app
 
-# Copy package definition
+# Copy the package definition
 COPY package*.json ./
 
-# Install dependencies
+# Install all dependencies
 RUN npm install
 
-# Copy source files
+# Copy the source files
 COPY . .
 
-# Start backup script
+# Start the backup script
 CMD ["node", "index.js"]

Makefile

@@ -1,11 +1,15 @@
+# Include the environment variables
 include ./.env
 
+# Run the Docker image and attach the environment file
 docker_run: docker_build
 	docker run --rm --name github-backup -v $(FOLDER):/usr/src/backup --env-file ./.env github-backup 
 
+# Build the Docker image
 docker_build: docker_cleanup
 	docker build -t github-backup .
 
+# Cleanup Docker
 docker_cleanup:
 	docker stop github-backup || true
 	docker rm github-backup || true

README.md

@@ -4,17 +4,11 @@ Creates a local backup of your GitHub data.
 
 ## In Scope
 
-- ✅ Repositories: cloned, public and private ones, images from markdown files
+- ✅ Repositories: cloned, public and private ones
 - ✅ Releases: including images and assets
 - ✅ Issues: including comments and images, open and closed ones
-- ✅ User: details and starred repositories  
-
-## In Progress
-- ⏳ Repositories: attachments from markdown files
-- ⏳ Releases: attachments
-- ⏳ Issues: attachments
-- ⏳ Projects v1: related to repositories, users and organizations
-- ⏳ Projects v2
+- ✅ Markdown: images, uploaded to the GitHub editor
+- ✅ User: user details and starred repositories  
 
 ## Usage
 

index.js

@@ -13,7 +13,7 @@ const retryDelayRateLimit = 6 * 60
 const retryDelayOthers = 6
 
 const { USERNAME, TOKEN } = process.env
-const folder = '/usr/src/backup'
+const folder = '/usr/src/backup' // Will be deleted entirely!
 
 function delay(seconds) {
   return new Promise(resolve => {
@@ -281,4 +281,5 @@ async function backup() {
   }
 }
 
+// Run the backup
 backup()