From 3dd95c273aeb2521ac81ea6e7235b5c8ab7359cc Mon Sep 17 00:00:00 2001
From: Prajapati Kaushik <prajapatikaushik@gmail.com>
Date: Wed, 21 Feb 2024 08:17:06 +0000
Subject: [PATCH] feat: git push pull integration #8338

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index 99ed7b8..1d1df60 100755
--- a/README.md
+++ b/README.md
@@ -48,3 +48,43 @@ wiki_bundle:
 ```
 
 ### Step 4: Enjoy :)
+
+---
+### Store/sync wiki's page content on git/GitHub.
+
+The repository this feature supports storing and retrieving wiki page content on git/Github.  For that, configure git/Github details into the wiki config field.  Currently, support git/GitHub web URL(HTTPS) for pull and push.
+
+
+Example config in the wiki.config
+
+``` 
+push:
+  - type: git
+    url: https://github.com/gitHub-username/wiki-git.git
+    secret: `ENV:WIKI_GIT_TOKEN` # defines which env to use as a secret
+
+pull:
+  - type: git
+    url: https://github.com/gitHub-username/wiki-git.git
+    secret: `ENV:WIKI_GIT_TOKEN` # defines which env to use as a secret
+```
+
+- `type`: push target type.
+- `url`: GitHub Clone URL(HTTPS) where pull/push content.
+- `secret:` Personal access tokens for authentication.
+
+
+Git publish and pull links are in the wiki page admin dropdown.
+
+`Note:` If the GitHub repository is not empty, Pull first to sync the repository.
+
+---
+
+### Read-only wikis
+
+This feature supports preventing users from editing wiki page content that is being managed in git/Github.
+For that, set config option into wiki config field.
+```
+read-only: true
+```
+`read-only`: boolen true/false value. If this is set to true, the edit and add features are prohibited for the user.
\ No newline at end of file