aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-07-19 13:15:24 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-07-19 13:15:24 -0500
commit7568a94560b2381f7d7ba77f2c64473cf6842110 (patch)
tree4389dd5021bbe65abf1242cc82a542e6335a1d01 /README.md
parentAdd return type hints to BaseParser (diff)
downloadconfig-file-7568a94560b2381f7d7ba77f2c64473cf6842110.zip
Add more info on installation with poetry and zsh
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index c7eebda..3a54880 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ JSON, YAML, or TOML. For the time being, it only supports INI and JSON.
## Installation
-Config File is available to download through PyPI using pip.
+Config File is available to download through PyPI.
```bash
$ pip install config-file
@@ -29,6 +29,24 @@ If you want to manipulate YAML and TOML, you'll want to download the extras as w
$ pip install config-file[yaml, toml]
```
+You can also use Poetry.
+
+```bash
+$ poetry install config-file -E yaml -E toml
+```
+
+If you use ZSH as your shell, brackets (`[]`) are used for glob matching
+and you'll have to put the package name in quotes if you're downloading
+the extras too.
+
+```zsh
+% pip install 'config-file[yaml, toml]'
+
+OR
+
+% noglob pip install config-file[yaml, toml]
+```
+
## Usage
Say you have an INI file you want to manipulate. It must have an .ini