Skip to content

Commit 0373a7c

Browse files
committed
Update readme
1 parent 61c2b1e commit 0373a7c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,48 @@ Latest version is: 0.1.2
66

77
## Installation
88

9+
### Using `pip`
10+
11+
```sh
12+
pip install hierarchical-yaml
13+
```
14+
15+
### From Source
16+
17+
```
18+
git clone https://github.com/adobe/hierarchical-yaml
19+
cd hierarchical-yaml
20+
sudo python setup.py install
21+
```
22+
923
## Example
1024

1125
### Using the cli
26+
27+
```sh
28+
usage: hyaml [-h] [--output-file OUTPUT_FILE] [--format OUTPUT_FORMAT]
29+
[--filter FILTER] [--exclude EXCLUDE]
30+
[--skip-interpolation-validation]
31+
[--skip-interpolation-resolving] [--enclosing-key ENCLOSING_KEY]
32+
[--cwd CWD]
33+
path
34+
```
35+
1236
```sh
1337
hyaml examples/config_example/env=dev/region=us-east-1/cluster=cluster2
1438
```
1539

40+
The configuration output will be something like this:
41+
```
42+
cluster:
43+
description: 'This is cluster: cluster2. It is using c3.2xlarge instance type.'
44+
name: cluster2
45+
node_type: c3.2xlarge
46+
region:
47+
location: us-east-1
48+
env: dev
49+
```
50+
1651
Where the examples folder looks something like this:
1752
```
1853
$ tree examples/config_example

0 commit comments

Comments
 (0)