📝 docs(README): add screenshots section with guidelines
Some checks failed
Build and Push Docker Image / build (push) Has been cancelled
Some checks failed
Build and Push Docker Image / build (push) Has been cancelled
- introduce screenshots section in README with suggested captures - recommend storing images as WebP or PNG and keeping file size small - advise on blurring or redacting sensitive data before committing 💄 style(images): update application icons - modify `icon-192.png` and `icon-512.png` for consistent style 🔧 chore(images): add .gitkeep to docs/img directory - include .gitkeep to ensure directory presence in version control
This commit is contained in:
parent
6ee4087dfd
commit
3fd950e95c
4 changed files with 14 additions and 0 deletions
13
README.md
13
README.md
|
|
@ -16,6 +16,19 @@ Self-hosted overview for rented servers (VPS, dedicated, storage, managed). Mult
|
|||
- Tailwind via CDN, Leaflet for maps
|
||||
- Uvicorn as ASGI server
|
||||
|
||||
## Screenshots
|
||||
Store optimized images in `docs/img/`. Suggested captures (add the files to avoid broken links):
|
||||
- `docs/img/dashboard.webp` — dashboard overview.
|
||||
- `docs/img/server-detail.webp` — server detail/edit view.
|
||||
- `docs/img/map.webp` — per-user map view.
|
||||
|
||||
Ready-to-display slots (fill the files above):
|
||||

|
||||

|
||||

|
||||
|
||||
Recommended: use WebP or PNG, keep files small (<400 KB), blur/redact sensitive data before committing.
|
||||
|
||||
## Containers and Images
|
||||
- Public repo: `https://github.com/nocci-sl/fleetledger`.
|
||||
- Prebuilt image on GHCR: `ghcr.io/nocci-sl/fleetledger:latest` (plus commit-tagged `ghcr.io/nocci-sl/fleetledger:<git-sha>`).
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 593 B After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 320 KiB |
1
docs/img/.gitkeep
Normal file
1
docs/img/.gitkeep
Normal file
|
|
@ -0,0 +1 @@
|
|||
|
||||
Loading…
Add table
Add a link
Reference in a new issue