diff --git a/README.md b/README.md index 73d4ec5..f7f777a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -# gitm +# Gitm +Automatic git mirroring script. -Automatic git mirroring script \ No newline at end of file +### How it works +This is a simple script that intercepts commands like `git init` and `git push` and automatically configures and pushes to many different remotes. + +### Usage +To use this script, create a file called `.gitm.toml` and populate it with repositories like so: +```toml +[repos] +origin = "https://gitea.arsenm.dev/Arsen6331/gitm.git" +gitlab = "https://gitea.arsenm.dev/moussaelianarsen/gitm.git" +``` \ No newline at end of file diff --git a/README.md.o b/README.md.o deleted file mode 100644 index f7f777a..0000000 --- a/README.md.o +++ /dev/null @@ -1,13 +0,0 @@ -# Gitm -Automatic git mirroring script. - -### How it works -This is a simple script that intercepts commands like `git init` and `git push` and automatically configures and pushes to many different remotes. - -### Usage -To use this script, create a file called `.gitm.toml` and populate it with repositories like so: -```toml -[repos] -origin = "https://gitea.arsenm.dev/Arsen6331/gitm.git" -gitlab = "https://gitea.arsenm.dev/moussaelianarsen/gitm.git" -``` \ No newline at end of file