summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8f1a141..74fdf02 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
# aur-update
-automatically update PKGBUILD files for the AUR
+the sole command is :
+
+``aur-update [VERSION NUMBER] [TARBALL URL]``
+
+this updates the version number, release number, source url, and md5sum, allowing for a quick way to update the PKGBUILDS you maintain whenever a new upstream release is made.
+
+for example:
+
+``aur-update 0.1.0 'https://github.com/getchoo/aur-update/archive/0.1.0.tar.gz``