From b62257c779b1237b1c21c123ab86645af33c0adb Mon Sep 17 00:00:00 2001
From: xdrm-brackets <doowap31@gmail.com>
Date: Sun, 8 Oct 2017 13:01:39 +0200
Subject: [PATCH] Added 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..c3e4440
--- /dev/null
+++ b/README.md
@@ -0,0 +1,94 @@
+# apt-plus
+
+Linux `apt-get` wrapper which lets you store installed/removed/purged packages.
+
+### Install
+
+> ##### (1) Launch the install script
+```bash
+bash ./install_apt-plus.sh;
+```
+
+> ##### (2) Create a _manifest_ file
+```bash
+touch ~/.apt-plus;
+```
+
+> ##### (3) Give apt-plus the manifest file path
+```bash
+apt-plus -m ~/.apt-plus;
+```
+
+
+
+
+### Commands
+
+#### [1] Fetches packages from remote
+Strict equivalent to `apt-get update`.
+
+> `apt-plus -f`
+> `apt-plus --fetch`
+
+#### [2] Update your system packages
+It first fetches the packages from remote, then upgrades your packages, your kernel and finally removes useless data.
+
+> `apt-plus -u`
+> `apt-plus --update`
+
+
+#### [3] Install one or multiple packages
+It installs the given packages and store it in the _manifest_.
+Package names must be separated by spaces.
+
+> `apt-plus -i <packages>`
+> `apt-plus --install <packages>`
+
+You can specify a group for packages with the following syntax:
+> `apt-plus :group_name: -i <packages>`
+> `apt-plus :group_name: --install <packages>`
+
+#### [4] Install from a .deb file
+It installs the given package and store it in the _manifest_.
+The path does not need to be absolute;
+
+> `apt-plus -d <file>`
+> `apt-plus --deb <file>`
+
+You can specify a group for the package with the following syntax:
+> `apt-plus :group_name: -d <file>`
+> `apt-plus :group_name: --deb <file>`
+
+#### [5] Remove one or multiple packages
+It removes the given packages and store it in the _manifest_.
+Package names must be separated by spaces.
+In opposite of the **purge** command, it keeps the configuration files.
+
+> `apt-plus -r <packages>`
+> `apt-plus --remove <packages>`
+
+You can specify a group for packages with the following syntax:
+> `apt-plus :group_name: -r <packages>`
+> `apt-plus :group_name: --remove <packages>`
+
+#### [6] Purge one or multiple packages
+It purges the given packages and store it in the _manifest_.
+Package names must be separated by spaces.
+In opposite of the **remove** command, it does not keep the configuration files.
+
+> `apt-plus -p <packages>`
+> `apt-plus --purge <packages>`
+
+You can specify a group for packages with the following syntax:
+> `apt-plus :group_name: -p <packages>`
+> `apt-plus :group_name: --purge <packages>`
+
+
+#### [7] List stored packages
+It shows you the list of stored packages (managed with apt-plus).
+> `apt-plus -l`
+> `apt-plus --list`
+
+You can specify a group to show only with the syntax:
+> `apt-plus :group_name: -l`
+> `apt-plus :group_name: --list`
\ No newline at end of file