docs

Author: Matars

README.md

@@ -157,107 +157,47 @@ gh auth status
 
 Configuration file location: `~/.config/gitfetch/gitfetch.conf`
 
-The configuration file is automatically created on first run and contains two main sections:
+The configuration file is automatically created on first run. See `docs/providers.md` for detailed provider configuration and `docs/colors.md` for color customization options.
 
 ### [DEFAULT] Section
 
 ```ini
 [DEFAULT]
 username = yourusername
 cache_expiry_hours = 24
+provider = github
+provider_url = https://api.github.com
 ```
 
-- `username`: Your default GitHub username (automatically set from authenticated GitHub CLI user)
+- `username`: Your default username (automatically detected)
 - `cache_expiry_hours`: How long to keep cached data (default: 24 hours)
+- `provider`: Git hosting provider (github, gitlab, gitea, sourcehut)
+- `provider_url`: API URL for the provider
 
 ### [COLORS] Section
 
-gitfetch supports extensive color customization. All colors use ANSI escape codes.
+gitfetch supports extensive color customization. All colors use ANSI escape codes. See `docs/colors.md` for detailed color configuration options.
 
+````ini
 ```ini
 [COLORS]
 reset = \033[0m
 bold = \033[1m
-dim = \033[2m
-red = \033[91m
-green = \033[92m
-yellow = \033[93m
-blue = \033[94m
-magenta = \033[95m
-cyan = \033[96m
-white = \033[97m
-orange = \033[38;2;255;165;0m
-accent = \033[1m
-header = \033[38;2;118;215;161m
-muted = \033[2m
-0 = \033[48;5;238m
-1 = \033[48;5;28m
-2 = \033[48;5;34m
-3 = \033[48;5;40m
-4 = \033[48;5;82m
-```
-
-#### Color Reference
-
-- **Text Styles**:
-
-  - `reset`: Reset all formatting
-  - `bold`: Bold text
-  - `dim`: Dimmed text
-  - `accent`: Accent styling (bold)
-
-- **Basic Colors**:
-
-  - `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`: Standard ANSI colors
-  - `orange`: Custom orange color
+# ... color definitions ...
+````
 
-- **UI Elements**:
+See `docs/colors.md` for detailed color configuration options and customization examples.
 
-  - `header`: Section headers and main display text
-  - `muted`: Separators and underlines
+## Supported Providers
 
-- **Contribution Graph**:
-  - `0`: No contributions (lightest)
-  - `1`: 1-2 contributions
-  - `2`: 3-6 contributions
-  - `3`: 7-12 contributions
-  - `4`: 13+ contributions (darkest)
+gitfetch supports multiple Git hosting platforms:
 
-#### Customizing Colors
-
-To change colors, edit `~/.config/gitfetch/gitfetch.conf` and modify the ANSI escape codes:
-
-**Example: Change header color to blue**
-
-```ini
-header = \033[94m
-```
-
-**Example: Change contribution graph colors to a purple theme**
-
-```ini
-0 = \033[48;5;235m  # Dark gray for no contributions
-1 = \033[48;5;60m   # Dark purple
-2 = \033[48;5;62m   # Medium purple
-3 = \033[48;5;64m   # Light purple
-4 = \033[48;5;66m   # Bright purple
-```
-
-**Common ANSI Color Codes**:
-
-- `\033[91m` = Bright Red
-- `\033[92m` = Bright Green
-- `\033[93m` = Bright Yellow
-- `\033[94m` = Bright Blue
-- `\033[95m` = Bright Magenta
-- `\033[96m` = Bright Cyan
-- `\033[97m` = Bright White
-
-**Background Colors** (for contribution blocks):
-
-- `\033[48;5;{color_code}m` where color_code is 0-255 (256-color palette)
+- **GitHub** - Uses GitHub CLI (gh) for authentication
+- **GitLab** - Uses GitLab CLI (glab) for authentication
+- **Gitea/Forgejo/Codeberg** - Direct API access with personal access tokens
+- **Sourcehut** - Direct API access with personal access tokens
 
-Changes take effect immediately - no restart required.
+See `docs/providers.md` for detailed setup instructions for each provider.
 
 ## Caching
 

docs/colors.md

@@ -0,0 +1,65 @@
+# Color Configuration
+
+gitfetch uses ANSI color codes for terminal output. Colors can be customized in the `[COLORS]` section of the config file.
+
+## Available Colors
+
+The following color keys can be customized:
+
+### Text Formatting
+
+- `reset`: Reset all formatting
+- `bold`: Bold text
+- `dim`: Dimmed text
+
+### Basic Colors
+
+- `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
+
+### Special Colors
+
+- `orange`: Orange color
+- `accent`: Accent color for highlights
+- `header`: Header text color
+- `muted`: Muted text color
+
+### Contribution Graph Colors (0-4)
+
+- `0`: Lowest contribution level
+- `1`: Low contribution level
+- `2`: Medium contribution level
+- `3`: High contribution level
+- `4`: Highest contribution level
+
+## Configuration
+
+Colors use ANSI escape codes. Examples:
+
+```ini
+[COLORS]
+reset = \033[0m
+bold = \033[1m
+red = \033[91m
+green = \033[92m
+blue = \033[94m
+header = \033[38;2;118;215;161m
+0 = \033[48;5;238m
+1 = \033[48;5;28m
+```
+
+## ANSI Color Codes
+
+- `\033[0m`: Reset
+- `\033[1m`: Bold
+- `\033[2m`: Dim
+- `\033[91m`: Bright Red
+- `\033[92m`: Bright Green
+- `\033[93m`: Bright Yellow
+- `\033[94m`: Bright Blue
+- `\033[95m`: Bright Magenta
+- `\033[96m`: Bright Cyan
+- `\033[97m`: Bright White
+
+For 256-color codes, use `\033[38;5;{color_code}m` for foreground or `\033[48;5;{color_code}m` for background.
+
+For RGB colors, use `\033[38;2;{r};{g};{b}m` for foreground or `\033[48;2;{r};{g};{b}m` for background.

docs/providers.md

@@ -0,0 +1,47 @@
+# Git Providers
+
+gitfetch supports multiple Git hosting providers. Configure your preferred provider in the config file.
+
+## Supported Providers
+
+### GitHub
+
+- **provider**: `github`
+- **provider_url**: `https://api.github.com`
+- **Requirements**: GitHub CLI (`gh`) must be installed and authenticated
+- **Authentication**: Run `gh auth login`
+
+### GitLab
+
+- **provider**: `gitlab`
+- **provider_url**: `https://gitlab.com`
+- **Requirements**: GitLab CLI (`glab`) must be installed and authenticated
+- **Authentication**: Run `glab auth login`
+
+### Gitea/Forgejo/Codeberg
+
+- **provider**: `gitea`
+- **provider_url**: Custom URL (e.g., `https://codeberg.org`, `https://gitea.com`)
+- **Requirements**: None (uses API directly)
+- **Authentication**: Set personal access token in environment or use CLI tools
+
+### Sourcehut
+
+- **provider**: `sourcehut`
+- **provider_url**: `https://git.sr.ht`
+- **Requirements**: None (uses API directly)
+- **Authentication**: Set personal access token in environment
+
+## Configuration
+
+Set the provider and URL in your `gitfetch.conf`:
+
+```ini
+[DEFAULT]
+provider = github
+provider_url = https://api.github.com
+```
+
+## Adding New Providers
+
+To add support for a new Git provider, implement a new fetcher class in `fetcher.py` and update the provider selection logic in `cli.py`.