From 40a8682f0b3aad9f9d209272014a09262ca99d9e Mon Sep 17 00:00:00 2001
From: Tinyblargon <76069640+Tinyblargon@users.noreply.github.com>
Date: Wed, 6 Dec 2023 15:22:10 +0000
Subject: [PATCH] docs:

---
 README.md                       |  4 ++++
 docs/style-guide/style-guide.md | 19 +++++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 docs/style-guide/style-guide.md

diff --git a/README.md b/README.md
index 7093cdce..d9855499 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/docs/style-guide/style-guide.md b/docs/style-guide/style-guide.md
new file mode 100644
index 00000000..cf5dfb87
--- /dev/null
+++ b/docs/style-guide/style-guide.md
@@ -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)