From cb936d00f02561c459ceaff0ae369cd6e91c4046 Mon Sep 17 00:00:00 2001
From: abs3nt <abs3nt@asdf.cafe>
Date: Mon, 7 Oct 2024 19:38:28 -0700
Subject: [PATCH] readme

---
 readme.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..d3d65ad
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,79 @@
+# repo-manager
+
+## installation
+
+- Sheldon
+
+```
+sheldon add repo-manager --github abs3ntdev/repo-manager
+```
+
+- zinit
+
+```
+zinit light abs3ntdev/repo-manager
+```
+
+## usage
+
+```
+Usage: repo <command> <repository>
+
+Commands:
+  get        Clone a repository to the repos directory
+  open       Open the current repository in the browser
+  aur        Clone an AUR repository
+  list       List all repositories
+  go|goto    Navigate to a repository
+  new|create Create a new repository
+  help       Show this help message
+
+Examples:
+  repo get github.com/user/repo
+  repo open
+```
+
+## configuration
+
+### hooks
+
+hooks are configured by overriding the functions provided in the plugin in hooks.zsh
+the default hooks are:
+
+```
+post_repo_clone() {
+  cd "$1"
+}
+
+post_repo_goto() {
+  cd "$1"
+}
+
+post_repo_new() {
+  cd "$1"
+}
+```
+
+you can override these in your .zshrc or in a file sourced by your .zshrc to do whatever you want. example:
+
+```
+post_repo_clone() {
+  code "$1"
+}
+
+post_repo_goto() {
+  nvim "$1"
+}
+
+post_repo_new() {
+  some_script "$1"
+}
+```
+
+### base directory
+
+the base directory is set via ENV. the default is $HOME/repos you can change this by adding the following to your .zshrc
+
+```
+export REPO_BASE_DIR="whatever/you/want"
+```