Skip to content

Commit

Permalink
docs:
Browse files Browse the repository at this point in the history
  • Loading branch information
Tinyblargon committed Dec 6, 2023
1 parent 3eb3244 commit 40a8682
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Proxmox API in golang. For /api2/json. Work in progress.

Starting with Proxmox 5.2 you can use cloud-init options.

## Contributing

Want to help with the project please refer to our [style-guide](docs/style-guide/style-guide.md).

## Build

```sh
Expand Down
19 changes: 19 additions & 0 deletions docs/style-guide/style-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Style-Guide

**`Notice: this guide is still in development!`**

This document is there to outline the development principles, style and quality of code. The goal of this guide is to homogenies the codebase. This guide will not be enforced to the letter but rather to it's spirit.

## Project Goals

The main goal of the project is to provide an intuitive [Software Development Kit (SDK)](https://www.ibm.com/cloud/blog/sdk-vs-api) for the [Proxmox Virtual Environment (PVE)](https://www.proxmox.com/en/proxmox-ve).

The secondary goal of the project is to provide a [Command Line Interface (CLI)](https://en.wikipedia.org/wiki/Command-line_interface) to interact with the PVE. A goal of this CLI is provide implementation examples of this SDK.

### Command Line Interface

More information about the CLI van be found is [cli.md](cli.md)

### Software Development Kit

More information about the SDK van be found is [sdk.md](sdk.md)

0 comments on commit 40a8682

Please sign in to comment.