diff --git a/README.md b/README.md index f4e975c..42323c9 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,41 @@ > ***Almost to a point you can use it*** :) -Packager is a simple yet powerful package manager \ No newline at end of file +Packager is a simple yet powerful package manager + +## Install a package +pkgr supports fetching packages with a: +- path +- url (http/https) +- package locator + +```shell +# example with path +pkgr install ./foxy/snek.pkg +# example with url +pkgr install https://example.com/doggo.pkg +# example with package locator +pkgr install foo:stable,bar +``` + +## Composing a package +Right now, pkgr does not have a compose/package command. (it's in the works dw!) +You can create a package with `pkg.py`! + +```shell +# Usage: pkg.py [ ...] +# example: +python pkg.py manifest.toml example.pkg root/ source/ scripts/ +# this will create a package with an archive that look like this: +# [header+manifest] +# ... +# [archive: +# root/ +# source/ +# scripts/ +# ] +``` + +It's not perfect, but it'll get the job done :) + +