Update README.md

README.md

@@ -1,17 +1,71 @@
 # XPipe Vault (Keep this repository private!)
 
-It works! The git remote push succeeded. However, no connections have been pushed to this git repository yet.
+This repository contains all connection information that is designated to be shared.
 
-## Adding connections to the repository
+You can sync with this repository in all XPipe application instances the same way, every change you make in one instance will be reflected in the repository. 
 
-By default, no categories are set to shared so that you have explicit control on what connections to commit.
+## Category list
 
-To have your connections of a category put inside your git repository,
+- **Connections**
-you either need to right-click the category or click on the `⚙️` icon when hovering over the category
+- **Scripts**
-in your `Connections` tab under the category overview on the left side.
+- **Identities**
-Then click on `Add to git repository` to sync the category and connections to your git repository.
+  - [**Synced**](categories/69aa5040-28dc-451e-b4ff-1192ce5e1e3c)
-This will add all shareable connections in that category to the git repository.
+- **Macros**
 
-## Local connections are not synced
+## Connection list
+
+**All identities / Synced**
+
+- [**aaa**](stores/1ef9a848-a1d2-4a86-a22d-5ce28932500e)
+- [**nerdbox-user**](stores/8216bd34-4608-4b86-8d9f-a02e3cfc5cfc)
+- [**Pihole**](stores/37e31ca2-5cea-4373-9664-894419947d2b)
+
+
+## Secret encryption
+
+You have the option to fetch any sensitive information like passwords from outside sources like password managers or enter them at connection time through a prompt window. In that case, XPipe doesn't have to store any secrets itself.
+
+In case you choose to store passwords and other secrets within XPipe, all sensitive information is encrypted when it is saved using AES with either:
+
+- A dynamically generated key file `vaultkey` (The data can then only be decrypted with that file present)
+- A custom passphrase that can be set for your user in the vault settings menu (This option can only as secure as the password you choose)
+
+By default, general connection data is not encrypted, only secrets are.
+So things like hostnames and usernames are stored without encryption, which is in line with many other tools.
+There is an available setting in the vault settings menu to encrypt all connection data if you want to do that.
+
+## Cloning the repository on other systems
+
+Nowadays, most providers require a personal access token (PAT) to authenticate from the command-line instead of traditional passwords.
+You can find common (PAT) pages here:
+- **GitHub**: [Personal access tokens (classic)](https://github.com/settings/tokens)
+- **GitLab**: [Personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
+- **BitBucket**: [Personal access token](https://support.atlassian.com/bitbucket-cloud/docs/access-tokens/)
+- **Gitea**: `Settings -> Applications -> Manage Access Tokens section`
+Set the token permission for repository to Read and Write. The rest of the token permissions can be set as Read.
+
+Even if your git client prompts you for a password, you should enter your token unless your provider still uses passwords.
+
+If you don't want to enter your credentials every time, you can use any git credentials manager for that.
+For more information, see for example:
+- https://git-scm.com/doc/credential-helpers
+- https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git
+
+Some modern git clients also take care of storing credentials automatically.
+
+## Troubleshooting
+
+### Adding connections to the repository
+
+By default, no connection categories are set to sync so that you have explicit control on what connections to commit.
+
+To have your connections of a category put inside your git repository, you first need to change its sync configuration.
+In your `Connections` tab under the category overview on the left side, you can open the category configuration menu either by right-clicking the category or click on the `⚙️` icon when hovering over the category, and then clicking on the `🔧` configure button.
+
+Then, set the `Sync with git repository` value to `Yes` to sync the category and connections to your git repository.
+This will add all syncable connections in that category to the git repository.
+The sync settings for a category are inherited by default from its parent if not explicitly set.
+
+### Local connections are not synced
 
 Any connection located under the local machine can not be shared as it refers to connections and data that are only available on the local system.