[PR #472] [MERGED] docs: update readme #495

New issue

Closed

opened 2026-02-28 00:42:24 +03:00 by kerem · 0 comments

kerem commented

2026-02-28 00:42:24 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Telmate/proxmox-api-go/pull/472
Author: @NemoDacremont
Created: 10/8/2025
Status: ✅ Merged
Merged: 10/18/2025
Merged by: @Tinyblargon

Base: master ← Head: docs/update-readme

📝 Commits (7)

d30b055 feat: add cli build, autocompletion generation and clean in makefile
efd70fc docs: update README for the new CLI and move examples in separate directory
9f3cc7f docs: fix some typos and rephrase JSON config format in README
45f6014 docs: move back json files to a single markdown, and update readme to link to the new file
af6f1a9 docs: add advices on how to bootstrap proxmox to run tests
070eb95 docs: move all config examples to markdown files instead of json files
0679fb8 Merge branch 'master' into docs/update-readme

📊 Changes

11 files changed (+345 additions, -318 deletions)

View changed files

📝 Makefile (+30 -0)
📝 README.md (+49 -318)
➕ docs/config-examples/README.md (+44 -0)
➕ docs/config-examples/clone-qemu.md (+13 -0)
➕ docs/config-examples/cloud-init.md (+64 -0)
➕ docs/config-examples/create-acme-account.md (+12 -0)
➕ docs/config-examples/create-qemu.md (+55 -0)
➕ docs/config-examples/create-storage.md (+33 -0)
➕ docs/config-examples/set-acme-plugin.md (+10 -0)
➕ docs/config-examples/set-metrics-server.md (+18 -0)
➕ docs/config-examples/set-user.md (+17 -0)

📄 Description

I updated the README and the Makefile to add things, here is a list of them :

Add rules in the Makefile to build the CLI and generate bash completion and install it locally
Explain how to use the new CLI
Precise that the legacy CLI is deprecated
Move all JSON config examples in a separate directory to make the main README smaller
Remove newlines between commands in the legacy CLI examples
Add the new CLI first in proxy usage

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Telmate/proxmox-api-go/pull/472 **Author:** [@NemoDacremont](https://github.com/NemoDacremont) **Created:** 10/8/2025 **Status:** ✅ Merged **Merged:** 10/18/2025 **Merged by:** [@Tinyblargon](https://github.com/Tinyblargon) **Base:** `master` ← **Head:** `docs/update-readme` --- ### 📝 Commits (7) - [`d30b055`](https://github.com/Telmate/proxmox-api-go/commit/d30b0556da173c11fe5ed5b45b7b112d9bc6a64a) feat: add cli build, autocompletion generation and clean in makefile - [`efd70fc`](https://github.com/Telmate/proxmox-api-go/commit/efd70fc2f14dad96f64b27960f54225dfca1a347) docs: update README for the new CLI and move examples in separate directory - [`9f3cc7f`](https://github.com/Telmate/proxmox-api-go/commit/9f3cc7fdf8209984c849aef8ae73af82371d2263) docs: fix some typos and rephrase JSON config format in README - [`45f6014`](https://github.com/Telmate/proxmox-api-go/commit/45f601403aef552afe96f21c7e550484ab5f33c1) docs: move back json files to a single markdown, and update readme to link to the new file - [`af6f1a9`](https://github.com/Telmate/proxmox-api-go/commit/af6f1a9507ebc644e6d1f5d3196bcd678bd28afe) docs: add advices on how to bootstrap proxmox to run tests - [`070eb95`](https://github.com/Telmate/proxmox-api-go/commit/070eb95dc0b4f34eaec9f4bd940800d9444acf70) docs: move all config examples to markdown files instead of json files - [`0679fb8`](https://github.com/Telmate/proxmox-api-go/commit/0679fb8b740eb6c075d0137256f5bc362317f1a1) Merge branch 'master' into docs/update-readme ### 📊 Changes **11 files changed** (+345 additions, -318 deletions) <details> <summary>View changed files</summary> 📝 `Makefile` (+30 -0) 📝 `README.md` (+49 -318) ➕ `docs/config-examples/README.md` (+44 -0) ➕ `docs/config-examples/clone-qemu.md` (+13 -0) ➕ `docs/config-examples/cloud-init.md` (+64 -0) ➕ `docs/config-examples/create-acme-account.md` (+12 -0) ➕ `docs/config-examples/create-qemu.md` (+55 -0) ➕ `docs/config-examples/create-storage.md` (+33 -0) ➕ `docs/config-examples/set-acme-plugin.md` (+10 -0) ➕ `docs/config-examples/set-metrics-server.md` (+18 -0) ➕ `docs/config-examples/set-user.md` (+17 -0) </details> ### 📄 Description I updated the README and the Makefile to add things, here is a list of them : * Add rules in the Makefile to build the CLI and generate bash completion and install it locally * Explain how to use the new CLI * Precise that the legacy CLI is deprecated * Move all JSON config examples in a separate directory to make the main README smaller * Remove newlines between commands in the legacy CLI examples * Add the new CLI first in proxy usage --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>