From 7a461eb12509121d9f09480a37d7ac805ac9a7bc Mon Sep 17 00:00:00 2001
From: Luna <git@l4.pm>
Date: Wed, 2 Aug 2023 23:11:00 -0300
Subject: [PATCH] update readme

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cf00f7f..08877a5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # adversarial_mirroring
 
-adversarial mirroring of repositories that might want to fight back
\ No newline at end of file
+adversarial mirroring of repositories that might want to fight back
+
+## notes
+
+- dont use urls ending in `.git` the script will explode
+- the way this works is by copying all files from one branch to the other
+- that means u lose all git history. the price u pay for progress
+
+pros:
+- if the repo fights back they cant just force-push their changes away. they will forever stay in the mirror
+
+# usage
+
+```sh
+./adverserial_mirror.sh source_git_repo target_git_repo main_branch
+```
+
+./daemon.sh https://github.com/discord/erlpack https://gitdab.com/luna/adverserial-discord-api-spec master
\ No newline at end of file