Merge pull request #54 from joshuanianji/automated-documentation-update-8168017963

Automated documentation update

Author: joshuanianji

src/edgedb-cli/README.md

@@ -1,7 +1,7 @@
 
 # EdgeDB (edgedb-cli)
 
-EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts ~/.local/share/edgedb for data persistence.
+EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts the config and data folder.
 
 ## Example Usage
 
@@ -23,6 +23,25 @@ EdgeDB CLI via the official installation script. Includes the VSCode extension a
 
 - `magicstack.edgedb`
 
+## Note to Users
+
+This feature mounts the edgedb config and data folder to the host machine for persistence. To do so, it makes some assumptions about `edgedb info`:
+
+```bash
+$ edgedb info
+
+EdgeDB uses the following local paths:
+┌────────────┬────────────────────────────────────────┐
+│ Cache      │ /home/<user>/.cache/edgedb/            │
+│ Config     │ /home/<user>/.config/edgedb/           │
+│ CLI Binary │ /home/<user>/.local/bin/edgedb         │
+│ Data       │ /home/<user>/.local/share/edgedb/data/ │
+│ Service    │ /home/<user>/.config/systemd/user/     │
+└────────────┴────────────────────────────────────────┘
+```
+
+**These paths may change based on the OS!**. This feature is tested on Ubuntu and Debian and the paths match up, but may not work for others.
+
 ## OS and Architecture Support
 
 Architectures: `amd` and `arm`
@@ -33,10 +52,11 @@ Shells: `bash`, `zsh`, `fish`
 
 ## Changelog
 
-| Version | Notes                  |
-| ------- | ---------------------- |
-| 1.0.1   | Fix for non-root users |
-| 1.0.0   | Initial Version        |
+| Version | Notes                      |
+| ------- | -------------------------- |
+| 1.0.2   | Cache edgedb config folder |
+| 1.0.1   | Fix for non-root users     |
+| 1.0.0   | Initial Version            |
 
 
 ---