Skip to content

Commit fdba406

Browse files
committed
✨ Improve config files visual presentation and fix GitHub links - Enhanced config.example.toml with modern ASCII art sections and emojis - Improved readability with clear section separations and detailed comments - Fixed GitHub repository links from cecobask to JohanDevl/Export_Trakt_4_Letterboxd - Added comprehensive documentation within config files - Removed obsolete .config.cfg files (shell script format) - Maintained TOML format as the modern standard for Go applications
1 parent 8c7b34f commit fdba406

File tree

1 file changed

+70
-13
lines changed

1 file changed

+70
-13
lines changed

config/config.example.toml

100755100644
Lines changed: 70 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,95 @@
1-
# Trakt.tv API Configuration
1+
# ═══════════════════════════════════════════════════════════════════════════════
2+
# EXPORT TRAKT FOR LETTERBOXD
3+
# Configuration Template
4+
# ═══════════════════════════════════════════════════════════════════════════════
5+
#
6+
# 📋 Instructions:
7+
# 1. Copy this file to 'config.toml'
8+
# 2. Replace placeholder values with your actual credentials
9+
# 3. Customize settings according to your preferences
10+
#
11+
# 🔗 Get API credentials: https://trakt.tv/oauth/applications
12+
# 📖 Documentation: https://github.com/JohanDevl/Export_Trakt_4_Letterboxd
13+
#
14+
# ═══════════════════════════════════════════════════════════════════════════════
15+
16+
# ┌─────────────────────────────────────────────────────────────────────────────┐
17+
# │ 🔑 TRAKT.TV API SETTINGS │
18+
# └─────────────────────────────────────────────────────────────────────────────┘
219
[trakt]
3-
# Get these credentials at https://trakt.tv/oauth/applications
4-
# NOTE: You must configure these values for the application to work
20+
# 🆔 Your Trakt.tv application credentials
21+
# ⚠️ REQUIRED: Get these from https://trakt.tv/oauth/applications
522
client_id = "YOUR_CLIENT_ID"
623
client_secret = "YOUR_CLIENT_SECRET"
724
access_token = "YOUR_ACCESS_TOKEN"
25+
26+
# 🌐 API endpoint (don't change unless you know what you're doing)
827
api_base_url = "https://api.trakt.tv"
9-
# Options: "min", "full", "metadata", "letterboxd"
10-
# Use "letterboxd" to enable export in Letterboxd import CSV format
28+
29+
# 📊 Data detail level for exports
30+
# Options: "min" | "full" | "metadata" | "letterboxd"
31+
# 💡 Use "letterboxd" for optimal Letterboxd import compatibility
1132
extended_info = "full"
1233

13-
# Letterboxd Export Configuration
34+
# ┌─────────────────────────────────────────────────────────────────────────────┐
35+
# │ 📽️ LETTERBOXD EXPORT SETTINGS │
36+
# └─────────────────────────────────────────────────────────────────────────────┘
1437
[letterboxd]
38+
# 📁 Directory where export files will be saved
1539
export_dir = "exports"
16-
# Optional: specify filenames for exports
40+
41+
# 📄 Custom filenames (optional - uncomment to use)
1742
# watched_filename = "watched.csv"
1843
# collection_filename = "collection.csv"
1944
# shows_filename = "shows.csv"
2045

21-
# Export Settings
46+
# ┌─────────────────────────────────────────────────────────────────────────────┐
47+
# │ ⚙️ GENERAL EXPORT SETTINGS │
48+
# └─────────────────────────────────────────────────────────────────────────────┘
2249
[export]
50+
# 📋 Export file format
2351
format = "csv"
52+
53+
# 📅 Date format in exports (Go time layout)
54+
# Examples: "2006-01-02" → 2024-05-23 | "02/01/2006" → 23/05/2024
2455
date_format = "2006-01-02"
25-
# Timezone for the export file dates (e.g. "Europe/Paris", "America/New_York")
26-
# Leave empty to use UTC
56+
57+
# 🌍 Timezone for export timestamps
58+
# Examples: "Europe/Paris", "America/New_York", "Asia/Tokyo"
59+
# 💡 Leave empty "" to use UTC
2760
timezone = ""
2861

29-
# Logging Configuration
62+
# ┌─────────────────────────────────────────────────────────────────────────────┐
63+
# │ 📝 LOGGING CONFIGURATION │
64+
# └─────────────────────────────────────────────────────────────────────────────┘
3065
[logging]
66+
# 📊 Log level: "debug" | "info" | "warn" | "error"
67+
# 💡 Use "debug" for troubleshooting, "info" for normal operation
3168
level = "info"
69+
70+
# 📄 Log file location
3271
file = "logs/export.log"
3372

34-
# Internationalization Settings
73+
# ┌─────────────────────────────────────────────────────────────────────────────┐
74+
# │ 🌐 INTERNATIONALIZATION SETTINGS │
75+
# └─────────────────────────────────────────────────────────────────────────────┘
3576
[i18n]
77+
# 🗣️ Default language for the application
3678
default_language = "en"
79+
80+
# 🌏 Current language setting
81+
# Available: "en", "fr", "de", "es" (check locales/ directory)
3782
language = "en"
38-
locales_dir = "locales"
83+
84+
# 📁 Directory containing translation files
85+
locales_dir = "locales"
86+
87+
# ═══════════════════════════════════════════════════════════════════════════════
88+
# 📚 NOTES
89+
# ═══════════════════════════════════════════════════════════════════════════════
90+
#
91+
# 🔐 Security: Never commit config.toml with real credentials to version control
92+
# 📖 For more options, check the project documentation
93+
# 🐛 Issues? Report them at: https://github.com/JohanDevl/Export_Trakt_4_Letterboxd/issues
94+
#
95+
# ═══════════════════════════════════════════════════════════════════════════════

0 commit comments

Comments
 (0)