summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1413d5a..a2af466 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
-# pkg
+# PKG
+All in one package manager.
-All in one package manager \ No newline at end of file
+This is a C wrapper that integrates with the prebuilt package managers in various Operating Systems. The purpose of this wrapper is to enable a easier package management without having to know the flags and options of every package manager.
+
+## How to use
+
+`pkg <command>`
+
+### Commands
+
+* **c** *clean* - configure an email account
+
+* **h** *help* - shows help message
+
+* **i** *install* - installs selected packages
+
+* **q** *query* - display installed packages
+
+* **r** *remove* - remove a selected package
+
+* **s** *search* - look up for a package in the available repositories
+
+* **u** *update* - updates repos and packages
+
+## Authors:
+
+* Rafael Marçalo