From 83047880d8de9e15578b0b44777cf86d4f7bbb85 Mon Sep 17 00:00:00 2001 From: Fabio Caccamo Date: Thu, 16 Jan 2020 18:21:10 +0100 Subject: [PATCH] Updated README. [ci skip] --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7be79b3..0e4b4e7 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,14 @@ # 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. +## 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 -- [Features](#features) - [Installation](#installation) - [Usage](#usage) - [Basics](#basics) @@ -32,13 +38,6 @@ python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts ( - [Testing](#testing) - [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 - Run `pip install python-benedict`