diff options
| author | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 10:20:35 -0400 |
|---|---|---|
| committer | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 10:20:35 -0400 |
| commit | cabe8e57b99558dcb148585b4a2cd6ed996dd1c1 (patch) | |
| tree | 747d306604b84a10878a7b61cbe9b8e888c8ba39 /docs/index.md | |
| parent | Remove flake8 config (diff) | |
| download | config-file-cabe8e57b99558dcb148585b4a2cd6ed996dd1c1.zip | |
Add basic docs
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 29 |
1 files changed, 29 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 |