aboutsummaryrefslogtreecommitdiffstats
path: root/docs
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
parentRemove flake8 config (diff)
downloadconfig-file-cabe8e57b99558dcb148585b4a2cd6ed996dd1c1.zip
Add basic docs
Diffstat (limited to 'docs')
-rw-r--r--docs/index.md29
-rw-r--r--docs/installation.md25
-rw-r--r--docs/requirements.txt1
3 files changed, 55 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..8dc6ea9
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,29 @@
+## About Config File
+
+The Config File project is designed to allow you to easily manipulate your
+configuration files with the same simple API whether they are in INI, JSON,
+YAML, or TOML.
+
+## Quick Example
+
+```python
+from config_file import ConfigFile
+
+# Load any supported configuration file
+config = ConfigFile("~/myapp/config.ini")
+
+# Get values with automatic type conversion
+database_port = config.get('database.port', return_type=int)
+
+# Set new values
+config.set('database.host', 'localhost')
+
+# Save changes
+config.save()
+```
+
+## Next Steps
+
+- [Install Config File](installation.md) to get started
+- Check out the [Quick Start Guide](quick-start.md) for common usage patterns
+- Explore the [API Reference](api-reference.md) for detailed documentation
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]
+```
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..f2caded
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+mkdocs==1.6.1