zpi/README.md

40 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2024-03-17 09:05:41 +01:00
<img src="zrep-logo.png" width="150" align="left">
# Zrep Package Installer (zpi)
2024-02-27 16:48:58 +01:00
zpi is a powerful and user-friendly package manager for the Zsh shell. It allows you to easily install, manage, and share Zsh packages, such as plugins, themes, and scripts, directly from a central repository.
## What is it?
`zpi` in and of itself is the command line tool that you use to install and manage scripts that are placed in `$fpath` used by Zsh. The packages are available on [the zrep website](https://zrep.kekepower.com) where you can, if you want to share your own scripts, register for an account. By sharing your scripts with the community, you are probably making somebody's day easier.
You can read more in the Wiki.
2024-03-09 09:12:02 +01:00
## Key Features
- **Easy Installation**: zpi simplifies the process of installing Zsh packages. With a single command, you can install packages from the zrep repository.
- **Package Management**: zpi provides a set of commands to manage your installed packages. You can list, enable, disable, update, and remove packages effortlessly.
2024-03-09 09:12:02 +01:00
- **Centralized Repository**: All packages are stored in a central repository, making it convenient to discover and share Zsh packages with the community.
- **Automatic Setup**: zpi automatically sets up the necessary configuration files and directories, ensuring a smooth integration with your Zsh environment.
2024-03-09 09:12:02 +01:00
- **Customizable**: zpi allows you to customize the installation directory and other settings through a configuration file.
2024-03-09 09:12:02 +01:00
## Getting Started
To start using zpi, simply run the `zpi init` command to initialize the tool. zpi will guide you through the setup process and create the required configuration files.
2024-03-09 09:12:02 +01:00
Use the search function on **[the zrep website](https://zrep.kekepower.com)** to find useful scripts until a search function is added to the `zpi` script some time in the future.
Once initialized, you can explore and install packages using commands like `zpi install <author/package>`, `zpi list`, and `zpi enable <author/package>`.
2024-03-09 09:12:02 +01:00
## Contributing
zpi is an open-source project, and contributions are welcome! If you have any ideas, bug reports, or feature requests, please open an issue on the GitHub repository.
2024-03-09 09:12:02 +01:00
## License
zpi is released under the MIT License.