First commit add README

1 files changed, 17 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..743db5c
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+Repofish shell script
+
+ This is a simple shell script used to manage a local archlinux
+ repository.
+
+USAGE:
+
+The script uses two global variables:
+
+  SRC_PATH (where the single packages repos are)
+  REPO_PATH (the parh of the actual local repository)
+
+You can globally set these variables in your enviroment or just hardcode
+the values in the script. They are commented as a default.
+
+Add the script to your $PATH and use repo.sh --help to see all
+the available options.