commit e3867cab8d38887afea6d5625189b28883e87a57 parent 241d006659f7e157fb987fa86f1e11d7ccfc72c6 Author: Josh Moore <email@example.com> Date: Tue, 14 Jan 2020 21:23:35 -0500 Update README.md Diffstat:
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -1,4 +1,21 @@ # squidpm -The Squid Package Manager is a utility for easily managing local copies of public git repositories. Package management files are located in the `packages/` directory. See `packages/example` for an example of how you could add your own packages. +The Squid Package Manager is a utility for easily managing local copies of public git repositories. Package management scripts are located in the `packages/` directory. See `packages/example` for an example of how you could add your own packages. This is intended primarily to be a tool for personal use, but I will accept pull requests and add packages to this repository if they are genuinely libre software. + +## Installation +To install squidpm for the first time, run these commands: +``` +git clone https://github.com/joshiemoore/squidpm.git +cd squidpm +sudo ./squidpm.sh install squidpm +``` +After that, you will be able to simply run `sudo squidpm <operation> [package]` to perform package management operations. Note that all packages will be downloaded to the `squidpm/repos/` directory, so be sure to clone this repository in a location that has enough free space for what you're trying to do. + +## Operations +Here is a list of currently supported operations. + +* `install <package>` - Install a package. Look in the `packages/` directory to see which packages are currently available. +* `uninstall <package>` - Uninstall a package. +* `update <package>` - Download/install updates for a package. +* `list` - Print a list of currently installed squidpm packages.