Skip to content

Commit 21a0245

Browse files
docs(readme): badges + codegen diagram; embed README in packages; bump 0.2.1 (#22)
- README: NuGet/Downloads/ci/Built-with-Fallout/License badges, install snippet, ASCII codegen pipeline -> mermaid, fix stale Homelab link (Chrison-Homelab). - Directory.Build.props: PackageReadmeFile + pack the repo README so nuget.org renders it. - Bump library VersionPrefix 0.2.0 -> 0.2.1 so a fresh version carries the README. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a6e3dbf commit 21a0245

3 files changed

Lines changed: 32 additions & 9 deletions

File tree

‎Directory.Build.props‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
<PackageProjectUrl>https://github.com/Chrison-dev/ProxmoxSharp</PackageProjectUrl>
1212
<RepositoryType>git</RepositoryType>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>
14+
<!-- Embed the repo README in every package so nuget.org renders it. -->
15+
<PackageReadmeFile>README.md</PackageReadmeFile>
1416
<PublishRepositoryUrl>true</PublishRepositoryUrl>
1517
<!-- Embed symbols in the assembly (GitHub Packages doesn't take .snupkg). -->
1618
<DebugType>embedded</DebugType>
@@ -21,4 +23,9 @@
2123
<UseAppHost>false</UseAppHost>
2224
</PropertyGroup>
2325

26+
<!-- Pack the repo-root README into every packable project (PackageReadmeFile above). -->
27+
<ItemGroup Condition="Exists('$(MSBuildThisFileDirectory)README.md')">
28+
<None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="\" Visible="false" />
29+
</ItemGroup>
30+
2431
</Project>

‎README.md‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,38 @@
11
# ProxmoxSharp
22

3+
[![NuGet](https://img.shields.io/nuget/v/Chrison.ProxmoxSharp.svg)](https://www.nuget.org/packages/Chrison.ProxmoxSharp/)
4+
[![Downloads](https://img.shields.io/nuget/dt/Chrison.ProxmoxSharp.svg)](https://www.nuget.org/packages/Chrison.ProxmoxSharp/)
5+
[![ci](https://github.com/Chrison-dev/ProxmoxSharp/actions/workflows/ci.yml/badge.svg)](https://github.com/Chrison-dev/ProxmoxSharp/actions/workflows/ci.yml)
6+
[![Built with Fallout](https://img.shields.io/badge/built%20with-Fallout-8A2BE2)](https://github.com/Fallout-build/Fallout)
7+
[![License: MIT](https://img.shields.io/github/license/Chrison-dev/ProxmoxSharp.svg)](LICENSE)
8+
39
A C# API client for Proxmox VE — **mostly code-generated from Proxmox's own
410
published API schema**, with a thin hand-written runtime for auth and transport.
511

6-
Built to be dogfooded by the [Homelab](https://github.com/Chrison-dev/Homelab)
12+
```sh
13+
dotnet add package Chrison.ProxmoxSharp
14+
dotnet tool install -g Chrison.ProxmoxSharp.Cli # the `proxmoxsharp` CLI
15+
```
16+
17+
Built to be dogfooded by the [Homelab](https://github.com/Chrison-Homelab/Homelab)
718
hub's C#-native IaC (the Discover → Converge path). Design + roadmap live in the
819
hub at `docs/plans/BL-009-proxmoxsharp-codegen.md`.
920

1021
## Approach
1122

23+
```mermaid
24+
flowchart LR
25+
APIDOC["📜 apidoc.js<br/>(pinned, from our node)"] --> SG["🔧 ProxmoxSharp.SchemaGen<br/>apidoc → OpenAPI 3.0"]
26+
SG --> KIOTA["⚙️ Kiota (pinned tool)<br/>generate C# client"]
27+
KIOTA --> API["📦 ProxmoxSharp.Api<br/>generated · tracks PVE version"]
28+
API --> RT["✍️ ProxmoxSharp<br/>hand-written runtime<br/>(token auth · {data:…} envelope)"]
29+
RT --> CLI["🖥️ proxmoxsharp CLI"]
30+
classDef gen fill:#e0e7ff,stroke:#4f46e5;
31+
class API gen;
1232
```
13-
apidoc.js (version-matched, pulled from our node)
14-
│ ProxmoxSharp.SchemaGen → OpenAPI 3.0
15-
▼
16-
Kiota (pinned dotnet tool) → generated C# request builders + models (ProxmoxSharp.Api)
17-
▼
18-
ProxmoxSharp = hand-written runtime over it (PVEAPIToken auth, {data:…} envelope)
19-
```
33+
34+
The generated client is **regenerated on build** (incrementally — only when the
35+
schema changes) and **not committed**.
2036

2137
The generated client is **regenerated on build** (incrementally — only when the
2238
schema changes) and **not committed**. Day-to-day work on the hand-written

‎src/ProxmoxSharp/ProxmoxSharp.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Bumped to 0.2.0 so the active 0.2.0-preview.N line outranks the earlier
1111
0.1.0 stable in NuGet ordering — a `0.1.0-preview.*` float would otherwise
1212
resolve the stale 0.1.0 stable (prereleases sort below their release). -->
13-
<VersionPrefix>0.2.0</VersionPrefix>
13+
<VersionPrefix>0.2.1</VersionPrefix>
1414
<!-- Public nuget.org ID uses the reserved Chrison.* prefix (the bare
1515
'ProxmoxSharp' ID is taken on nuget.org by an unrelated project).
1616
AssemblyName/RootNamespace stay 'ProxmoxSharp' (project name) so

0 commit comments

Comments
 (0)