From eb9ec743fb0ee0b858af90635a87e6d2878e1e93 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Luttringer?= <seblu@seblu.net>
Date: Sat, 17 Oct 2015 00:42:41 +0200
Subject: [PATCH] Add a README

---
 README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..191bef5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,94 @@
+agetpkg
+=======
+
+Introduction
+------------
+**agetpkg** is a command line tool used to quickly list/get/install packages stored on the [Archlinux Archive](https://wiki.archlinux.org/index.php/Arch_Linux_Archive).
+
+**agetpkg** means **A**rchive **G**et **P**ackage.
+
+Usage
+-----
+
+###### Download xterm version 296
+```bash
+agetpkg ^xterm$ 296
+# or
+agetpkg -g ^xterm$ 296
+```
+
+###### List xterm version 296
+```bash
+agetpkg -l ^xterm$ 296
+```
+
+###### Install all gvfs packages in version 1.26.0 release 3
+```bash
+agetpkg -i gvfs 1.26.0 3
+```
+
+###### List only i686 packages of nftables
+```bash
+agetpkg -l -A i686 -- nftables
+```
+
+###### Force update of the index before listing packages matching i3
+```bash
+agetpkg -u -l i3-wm
+```
+
+###### Download all version of xterm
+```bash
+agetpkg -l -a ^xterm$
+```
+
+###### Use another archive url
+```bash
+agetpkg --url http://archlinux.arkena.net/archive/packages/.all/ -l bash$
+```
+or
+```bash
+export ARCHIVE_URL=http://archlinux.arkena.net/archive/packages/.all/
+agetpkg -l bash$
+```
+
+###### Run agetpkg in debug mode
+```bash
+agetpkg --debug -l coreutils
+```
+
+###### Display current version
+```bash
+agetpkg --version
+```
+
+Installation
+------------
+
+To install the current released version of **agetpkg**, run:
+```bash
+pacman -S agetpkg
+```
+
+To install the git development version, run:
+```bash
+makepkg
+pacman -U agetpkg-*-any.pkg.tar.xz
+```
+
+Dependencies
+------------
+- [Python 3.x](http://python.org/download/releases/)
+- [PyXDG](http://freedesktop.org/wiki/Software/pyxdg)
+
+Sources
+-------
+**agetpkg** sources are available on [github](https://github.com/seblu/agetpkg/).
+
+License
+-------
+**agetpkg** is licensied under the term of [GPL v2](http://www.gnu.org/licenses/gpl-2.0.html).
+
+AUTHOR
+------
+**agetpkg** was started by Sébastien Luttringer in September 2015.
-- 
GitLab