Commit 71031e28d840eb0ae73132df29d85d45831aaf77

Thomas de Grivel 2023-02-23T20:22:25

readme

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b88018
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# rbpkg v0.1
+
+Minimalist package manager for all UNIX systems.
+
+Only dependency is Ruby.
+
+
+
+## Installation
+
+```
+curl [https://git.kmx.io/kmx.io/rbpkg/_blob/master/bin/rbpkg_bootstrap](https://git.kmx.io/kmx.io/rbpkg/_blob/master/bin/rbpkg_bootstrap) | sh
+. ~/rbpkg/etc/profile
+```
+
+
+## Examples
+
+Install a package :
+
+```
+rbpkg install libbsd
+```
+
+Upgrade a package :
+
+```
+rbpkg upgrade libbsd
+```
+
+Uninstall a package :
+
+```
+rbpkg uninstall libbsd
+```
+
+
+## Usage
+
+```
+Usage: rbpkg COMMAND REPO ...
+
+Source directory commands :
+ clone            shortcut for git clone
+ clean-sources    remove source directory
+ fetch            shortcut for git fetch
+ pull             shortcut for git pull
+ checkout TREE    shortcut for git checkout
+
+Build commands :
+ configure        configure build for this system
+ clean-configure  remove configure-done tag file
+ build            run parallel build
+ clean-build      remove object files
+ test             run tests
+
+Package commands : 
+ fake             install into fake installation directory
+ clean-fake       remove fake installation directory
+ package          build package
+ clean-package    remove package file
+ install          install package
+ uninstall        uninstall package
+ upgrade          upgrade package
+
+Misc commands :
+ clean-all        clean all files
+ info             show information
+```