Skip to content

Commit 453603d

Browse files
committed
Enhance README with detailed feature descriptions and update styling in SCSS files. Improved clarity and organization of API coverage, UI components, real-time streaming, and testing information. Removed unnecessary lines in Docker color scheme and custom stylesheets.
1 parent 92db925 commit 453603d

3 files changed

Lines changed: 23 additions & 14 deletions

File tree

docs/_sass/color_schemes/docker.scss

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
---
2-
---
3-
41
$color-scheme: docker;
52
$body-background-color: $grey-dk-300;
63
$body-heading-color: $grey-lt-000;

docs/_sass/custom/custom.scss

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
---
2-
---
3-
41
.hero {
52
padding: 3rem 0;
63
text-align: center;

readme.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,29 @@ Connect to your Docker daemon via Unix socket, TCP, or TLS. Use the fluent API i
1515

1616
## Features
1717

18-
| **Full API coverage** | 100+ Docker Engine API v1.53 endpoints: containers, images, networks, volumes, swarm, services, nodes, tasks, secrets, configs, plugins, build, exec, distribution. |
19-
| **Livewire UI** | 15 management components with Flux UI styling and dark mode: dashboard, containers, images, networks, volumes, swarm, services, nodes, tasks, secrets, configs, plugins. |
20-
| **Real-time streaming** | Image pull progress via Server-Sent Events; container logs and stats; multiplexed stream decoding. |
21-
| **Type-safe DTOs** | Data Transfer Objects for list and inspect responses: `ImageSummary`, `ContainerSummary`, `SystemInfo`, `DiskUsage`, and more. |
22-
| **Selective caching** | Saloon cache plugin for read-only requests (info, version, image inspect/history) with configurable TTLs. |
23-
| **Connection flexibility** | Unix socket (default), TCP, or TLS with certificate support. Configurable timeouts and headers. |
24-
| **Docker Swarm** | Initialize, join, leave; manage services, nodes, tasks, secrets, and configs from the UI or API. |
25-
| **Architecture tested** | Lawman expectations for Saloon connector and requests; Pest for feature and unit tests. |
18+
### 🔌 Full API Coverage
19+
100+ endpoints across the Docker Engine API v1.53 — containers, images, networks, volumes, Swarm, services, nodes, tasks, secrets, configs, plugins, build, exec, and distribution.
20+
21+
### 🖥️ Built-in Livewire UI
22+
15 ready-to-use management components styled with Flux UI and dark mode support. Browse your dashboard, containers, images, networks, volumes, and the full Swarm surface — all from the browser.
23+
24+
### ⚡ Real-time Streaming
25+
Watch image pulls with live progress bars powered by Server-Sent Events. Stream container logs and stats with multiplexed stream decoding built in.
26+
27+
### 🧩 Type-safe DTOs
28+
First-class Data Transfer Objects for list and inspect responses — `ImageSummary`, `ContainerSummary`, `SystemInfo`, `DiskUsage`, and more — so you never work with raw arrays.
29+
30+
### 🗄️ Selective Caching
31+
Saloon cache plugin for read-only requests (info, version, image inspect/history) with configurable TTLs. Keep things fast without stale data.
32+
33+
### 🔗 Flexible Connections
34+
Connect via Unix socket (default), TCP, or TLS with full certificate support. Configurable timeouts and custom headers out of the box.
35+
36+
### 🐝 Docker Swarm Ready
37+
Initialize, join, and leave clusters. Manage services, nodes, tasks, secrets, and configs from the UI or programmatically through the API.
38+
39+
### ✅ Thoroughly Tested
40+
Lawman architectural expectations for the Saloon connector and requests. Pest-powered feature and unit tests with full mock support — no daemon required.
2641

2742
---
2843

0 commit comments

Comments
 (0)