aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installation.md
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-08-16 10:20:35 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-08-16 10:20:35 -0400
commitcabe8e57b99558dcb148585b4a2cd6ed996dd1c1 (patch)
tree747d306604b84a10878a7b61cbe9b8e888c8ba39 /docs/installation.md
parentRemove flake8 config (diff)
downloadconfig-file-cabe8e57b99558dcb148585b4a2cd6ed996dd1c1.zip
Add basic docs
Diffstat (limited to 'docs/installation.md')
-rw-r--r--docs/installation.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 0000000..a1212bc
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,25 @@
+# Installation
+
+Config File is available to download through PyPI and can be installed using pip.
+It requires Python 3.9+ to install.
+
+## Basic Installation
+
+For basic functionality with INI and JSON support:
+
+```bash
+pip install config-file
+```
+
+This will install the core package with support for:
+
+- **INI files** (using Python's built-in `configparser`)
+- **JSON files** (using Python's built-in `json`)
+
+## Installing with Extras
+
+If you want to work with YAML and TOML files, you'll need to install the optional dependencies:
+
+```bash
+pip install config-file[yaml,toml]
+```