From 685b3605d8170938b2e083d38b9c2d93489d9ff8 Mon Sep 17 00:00:00 2001
From: Osama Adam <osamaadamme@gmail.com>
Date: Mon, 5 Feb 2024 00:40:38 +0200
Subject: [PATCH] updating readme to add documentation for `push` and `clone`
 commands

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

diff --git a/README.md b/README.md
index 129c821..9598238 100644
--- a/README.md
+++ b/README.md
@@ -209,3 +209,38 @@ cfgrr replicate --all
 ```
 
 :mag: For more info, run `cfgrr replicate --help`.
+
+#### Push:
+
+This subcommand allows the user to push the backed up files to a remote git repository.
+
+```sh
+cfgrr push
+```
+
+By default, this will push the changes to the remote `origin` on the current branch.
+
+To push to a different remote or branch:
+
+```sh
+cfgrr push origin backup-branch
+```
+
+:mag: For more info, run `cfgrr push --help`.
+
+#### Clone:
+
+This subcommand allows the user to clone the backed up files from a remote git repository.
+If a repository already exists, the latest changes will be pulled instead.
+
+```sh
+cfgrr clone <remote_url>
+```
+
+By default, this will clone the branch `master`. To clone a different branch:
+
+```sh
+cfgrr clone git@github.com:osamaadam/cfgrr.git --branch backup-branch
+```
+
+:mag: For more info, run `cfgrr clone --help`.