aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordacctal <dacctal@symlinx.net>2026-05-29 12:09:41 +0000
committerdacctal <dacctal@symlinx.net>2026-05-29 12:09:41 +0000
commit2339055b7cda6b786c044915d62d0b41b6676975 (patch)
treedb0276b74cab5736ffbb0d11345ea3e815582710 /README.md
parent68f97610695317483ef88c1ae0dcc08dfaab521a (diff)
added docs for updating and declaring packages
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 46d4b85..d6487ab 100644
--- a/README.md
+++ b/README.md
@@ -84,8 +84,7 @@ pkgit build [/path/to/project]
```
This can also be done without specifying the path (`pkgit build`) if you're in the project's root directory
-## Removal
-### Packages
+## Removing Packages
Removing (uninstalling) a package is as simple as it seems:
```
pkgit remove [pkg_name]
@@ -95,6 +94,27 @@ Or the short command:
pkgit r [pkg_name]
```
+## Updating Packages
+You can easily update your installed packages by running:
+```
+pkgit update
+```
+Or the short command:
+```
+pkgit u
+```
+
+## Declaring Packages
+If you prefer a declarative approach, you can use the config file (read below) as a package declaration file.
+When you're ready, you can declare all your packages at once with:
+```
+pkgit declare
+```
+Or the short command:
+```
+pkgit d
+```
+
## Dependency Management
As it is, pkgit is capable of dependency management, but you will likely have to specify the dependency URLs for each package you install in `<config_directory>/pkgit/init.lua`. There's not a universal way to check for dependencies without using an existing package manager (unless the package you're installing has a bldit.lua).