Merge branch 'main' into v0.6.4

grahampugh · May 23, 2024 · 966d636 · 966d636
2 parents 7756b7d + 1e9a334
commit 966d636
Showing 1 changed file with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -4,16 +4,31 @@ This utility is designed to convert Apple `plist` files to `yaml`, or `yaml` fil
 
 It can also convert `json` files to `plist`.
 
-## Prerequisites
+## Installation
+### Prerequisites
 
-The python `ruamel.yaml` module is required, which is not installed by default on Macs. The version of ruamel.yaml currently must be lower than 0.18.0. You can install it with `pip`, which you may also need to install first. A few other things need to be updated for ruamel to install:
+The python `ruamel.yaml` module is required, which is not installed by default on Macs. You can install it with `pip`, which you may also need to install first. A few other things need to be updated for ruamel to install:
 
 ```bash
 python -m ensurepip --user
 python -m pip install -U pip setuptools wheel ruamel.yaml<0.18.0 --user
 ```
 
-If you do not pre-install `ruamel.yaml`, the script will do it for you.
+If you do not pre-install `ruamel.yaml`, setup.py will do it for you.
+
+#### Local git repo install
+```bash
+git clone git@github.com:grahampugh/plist-yaml-plist && cd plist-yaml-plist
+python -m pip install .
+```
+
+#### Remote git repo install
+A github ssh key is required to run `pip install -r requirements.txt`.
+
+*requirements.txt*:
+```txt
+-e git+ssh://git@github.com/grahampugh/plist-yaml-plist#egg=plistyamlplist
+```
 
 ## Usage