From e1767f6f1fd6a2c4e701f507c6d3e07b1e4a40df Mon Sep 17 00:00:00 2001 From: "minecraftchest1@outlook.com" Date: Mon, 27 Jan 2025 14:22:49 -0600 Subject: [PATCH] Add installation to README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 15ec83e..b778eb1 100644 --- a/README.md +++ b/README.md @@ -9,5 +9,18 @@ DNScode is a project to help simplify DNS zone management, when using plain text files with Python, allowing for more flexability, compared to other DNS as code solutions. ## Installation +``` bash +# Create working directory +mkdir dnsproject +cd dnsproject -DNSCode is a single Python3 script, with very few dependencies, intented to be used as a module inside of another script. Just drop main.py into your project \ No newline at end of file +# Create virtual envrionment (optional, but highly recomended) +python3 -m venv .venv +source .venv/bin/activate + +# Install the dnscode package +pip install dnscode +``` + +## Usage +Todo \ No newline at end of file