Updated README. [ci skip]
This commit is contained in:
parent
b6a09f0153
commit
83047880d8
15
README.md
15
README.md
|
@ -16,8 +16,14 @@
|
||||||
# python-benedict
|
# python-benedict
|
||||||
python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts (`Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`) and many **utilities**... for humans, obviously.
|
python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts (`Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`) and many **utilities**... for humans, obviously.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- 100% **backward-compatible**, you can safely wrap existing dictionaries.
|
||||||
|
- Full **keypath** support using **keypath-separator** *(dot syntax by default)* or **list of keys**.
|
||||||
|
- Easy **I/O operations** with most common formats: `Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`.
|
||||||
|
- Many **utility** and **parse methods** to retrieve data as needed *(check the [API](#api) section)*.
|
||||||
|
- Well **tested**, check the badges ;)
|
||||||
|
|
||||||
## Index
|
## Index
|
||||||
- [Features](#features)
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Basics](#basics)
|
- [Basics](#basics)
|
||||||
|
@ -32,13 +38,6 @@ python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts (
|
||||||
- [Testing](#testing)
|
- [Testing](#testing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Features
|
|
||||||
- Full **keypath** support using **keypath-separator** *(dot syntax by default)* or **list of keys**.
|
|
||||||
- Easy **I/O operations** with most common formats: `Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`
|
|
||||||
- Many **utility** and **parse methods** to retrieve data as needed *(all methods listed below)*
|
|
||||||
- Well **tested**, check the badges ;)
|
|
||||||
- 100% **backward-compatible** *(you can replace existing dicts without pain)*
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
- Run `pip install python-benedict`
|
- Run `pip install python-benedict`
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue