Merge pull request #20 from bashpack-project/main

3.0.0

Author: ggtrd

CHANGELOG.md

@@ -1,18 +1,23 @@
-# Bashpack changes
+# Changes
 
 The released versions changelogs below are only about the main repository.
 
 ### 3.0.0
 *Incoming release date*
-##### Modified
-- The CLI has been redesigned has a "script manager", to download/install/run/remove scripts as subcommands
+
+##### Added
 - The CLI can now be installed offline by itself
 - Anyone can now host a repository for its own subcommands (edit sourceslist option from the configuration directory) 
 - Anyone can now host a repository for its own CLI (edit cli_url option from the configuration file)
 - Repositories are compatibles with Github, but can also be simple directories listing web servers
-- The CLI helper can now easily create an automation from a simple function to be able to automatically run a subcommand on the system (systemd only for now)
+- Documentation website at https://bashpack-project.github.io
+- Subcommand template is available with the option "-n'
+
+##### Modified
+- The CLI has been redesigned has a "script manager", to download/install/run/remove scripts as subcommands
+- The CLI helper can now easily create an automation from a simple function that allow to automatically run a subcommand on the system (systemd only for now)
 - When creating subcommands, the function "init_command()" can be used to run any requirements on the system (create automation, file etc... or anything else)
-- Subcommands provided from this project has moved to the [commands repository](https://github.com/bashpack-project/commands)
+- Subcommands provided from this repository has moved to the [commands repository](https://github.com/bashpack-project/commands)
 - Subcommands "update" and "install" are now merged in the "package" subcommand
 - Subcommand "verify" option "-c/--commands" replaced by "-d/--dependencies"
 - Publication system has been removed and replaced by the configuration option "cli_url"

README.md

@@ -1,6 +1,8 @@
 # Bashpack
 
-The Bashpack CLI is a versatile and user-friendly script manager designed to manage scripts on any Linux distro and use them as regular commands. It simplifies script management, security, and automation, making your administrative tasks more efficient.
+Bashpack is a versatile and user-friendly command-line script manager. It is designed to use scripts as regular commands on any Linux distro. It simplifies script management, security, and automation, making your administrative tasks more efficient.
+
+It can be compared to [PyPI](https://pypi.org/) for Python, [PowerShell Gallery](https://www.powershellgallery.com/) for PowerShell, [Registry](https://hub.docker.com/_/registry) for Docker, [Go Packages](https://pkg.go.dev/) for Go etc..., but for Shell scripts made to be compatible with any Unix based OS.
 
 Anyone can self-host its own subcommands repositories, and even its own CLI repository.
 
@@ -63,11 +65,11 @@ sudo bp --list
 
 ## Configuration
 
-Bashpack uses a configuration file located at `/etc/bashpack/bashpack.conf`. It is created and maintained automatically, but you can customize it according to your needs.
+A configuration file is located at `/etc/bashpack/bashpack.conf`. It is created and maintained automatically, and you can customize it according to your needs.
 
 ## Logs
 
-Bashpack maintains logs in `/var/log/bashpack`. You can view the logs using the following command:
+Logs are maintained in `/var/log/bashpack`. You can quickly view the logs using the following command:
 
 ```sh
 sudo bp --logs