diff --git a/README.md b/README.md index 706d29c..f067e7c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,10 @@ -# Zsh Repository Tool (zrep) +# zrep -zrep 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. +The Zsh Repository tool, akin to PyPi and pip -## Key Features +
-- **Easy Installation**: zrep simplifies the process of installing Zsh packages. With a single command, you can install packages from the zrep repository. +This is a work in progress. Some functionality is in place, but the back-end is still missing a lot. -- **Package Management**: zrep provides a set of commands to manage your installed packages. You can list, enable, disable, update, and remove packages effortlessly. +Would love help and feedback! -- **Centralized Repository**: All packages are stored in a central repository, making it convenient to discover and share Zsh packages with the community. - -- **Automatic Setup**: zrep automatically sets up the necessary configuration files and directories, ensuring a smooth integration with your Zsh environment. - -- **Customizable**: zrep allows you to customize the installation directory and other settings through a configuration file. - -## Getting Started - -To start using zrep, simply run the `zrep init` command to initialize the tool. zrep will guide you through the setup process and create the required configuration files. - -Once initialized, you can explore and install packages using commands like `zrep install `, `zrep list`, and `zrep enable `. - -## Contributing - -zrep 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. - -## License - -zrep is released under the MIT License. \ No newline at end of file