Skip to content

Commit 0cab15d

Browse files
itsDNNSclaude
andcommitted
Polish documentation: badges, generalize wording, clean up links
README.md: - Add license, version, and last-commit badges - Remove git clone Quick Start (dev workflow, not for end users) - Consolidate duplicate INSTALL.md links into one - Generalize Requirements to "DOCSIS cable modem or router" - Roadmap: "additional cable modem models" instead of "non-FritzBox" INSTALL.md: - Replace "your-nas-ip" with "your-host-ip" in Portainer/Dockhand sections for NAS-agnostic wording Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4d06f17 commit 0cab15d

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

INSTALL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Now continue with [First-Time Setup](#first-time-setup).
127127

128128
### Step 1: Open Portainer
129129

130-
Open your Portainer web UI (usually `https://your-nas-ip:9443`).
130+
Open your Portainer web UI (usually `https://your-host-ip:9443`).
131131

132132
### Step 2: Create a new stack
133133

@@ -155,7 +155,7 @@ volumes:
155155

156156
### Step 3: Open DOCSight
157157

158-
Open your browser and go to **http://your-nas-ip:8765**
158+
Open your browser and go to **http://your-host-ip:8765**
159159

160160
Now continue with [First-Time Setup](#first-time-setup).
161161

@@ -196,7 +196,7 @@ volumes:
196196

197197
### Step 3: Open DOCSight
198198

199-
Open your browser and go to **http://your-nas-ip:8765**
199+
Open your browser and go to **http://your-host-ip:8765**
200200

201201
Now continue with [First-Time Setup](#first-time-setup).
202202

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
<h1 align="center">DOCSight</h1>
66

7+
<p align="center">
8+
<a href="LICENSE"><img src="https://img.shields.io/github/license/itsDNNS/docsight" alt="License"></a>
9+
<a href="https://github.com/itsDNNS/docsight/pkgs/container/docsight"><img src="https://img.shields.io/github/v/tag/itsDNNS/docsight?label=version" alt="Version"></a>
10+
<a href="https://github.com/itsDNNS/docsight"><img src="https://img.shields.io/github/last-commit/itsDNNS/docsight" alt="Last Commit"></a>
11+
</p>
12+
713
<p align="center">
814
Docker container that monitors DOCSIS channel health on cable modems and publishes per-channel sensor data to Home Assistant via MQTT Auto-Discovery. Currently supports AVM FRITZ!Box Cable routers.
915
</p>
@@ -44,15 +50,7 @@ docker run -d --name docsight -p 8765:8765 -v docsight_data:/data ghcr.io/itsdnn
4450

4551
Open `http://localhost:8765` - the setup wizard guides you through configuration.
4652

47-
For detailed step-by-step instructions (including Portainer and Dockhand), see the **[Installation Guide](INSTALL.md)**.
48-
49-
### Using Docker Compose
50-
51-
```bash
52-
git clone https://github.com/itsDNNS/docsight.git
53-
cd docsight
54-
docker compose up -d
55-
```
53+
For Docker Compose, Portainer, Dockhand, and detailed step-by-step instructions, see the **[Installation Guide](INSTALL.md)**.
5654

5755
<details>
5856
<summary><h2>Configuration</h2></summary>
@@ -140,7 +138,7 @@ Copy `.env.example` to `.env` and edit:
140138

141139
## Requirements
142140

143-
- AVM FRITZ!Box Cable router (tested with 6690 Cable)
141+
- DOCSIS cable modem or router (currently supported: AVM FRITZ!Box Cable, tested with 6690 Cable)
144142
- MQTT broker (e.g., Mosquitto) - optional, for Home Assistant integration
145143

146144
## Roadmap
@@ -156,8 +154,8 @@ Copy `.env.example` to `.env` and edit:
156154

157155
### Multi-Modem Support
158156
- [ ] Plugin architecture for modem drivers
159-
- [ ] SNMP-based generic driver for non-FritzBox cable modems
160-
- [ ] Community-contributed drivers (Arris, Technicolor, Sagemcom)
157+
- [ ] SNMP-based generic driver for additional cable modem models
158+
- [ ] Community-contributed drivers (Arris, Technicolor, Sagemcom, etc.)
161159

162160
## Contributing
163161

0 commit comments

Comments
 (0)