Skip to content

Commit 1ce48e1

Browse files
authored
Create getting-started.md
1 parent 79c7f1e commit 1ce48e1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

getting-started.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Getting Started
2+
3+
A hook is basicly a Laravel service provider that is loaded automatically when that hook is enabled.
4+
A hook can have 3 states:
5+
* **Not-installed** - This hook is not installed, but exists in the application for some reason, this is mostly only the case if you are building your own hook. In this case you have the option to install or delete the hook.
6+
* **Disabled** - This hook is installed, means that it have been installed but its service providers are not loaded yet. In this case you have the option to uninstall or enable the hook.
7+
* **Enabled** - This hook is installed and enabled, means that it's service providers will now be loaded. In this case you have the option to disable or uninstall the hook.
8+
9+
When working with hook there are 4 actions:
10+
* **Install** - This will download the hook if not already downloaded and then run the installation of that hook.
11+
* **Enable** - After installing a hook, you will have to enable it in order to load it service providers.
12+
* **Disable** - If you ever need to disable the functionality that the hook came along with, you can always disable it to keep its configuration.
13+
* **Uninstall** - This will disable a hook if not already disabled and then remove all the configurations and undo the whole installation of a hook along with deleting it from the system.
14+
15+
The hook system comes with multiple Artisan commands:
16+
* *hook:check* - Check for updates and show hooks that can be updated
17+
* *hook:disable* - Disable a hook
18+
* *hook:enable* - Enable a hook
19+
* *hook:info* - Get information on a hook
20+
* *hook:install* - Download and install a hook from remote https://larapack.io
21+
* *hook:list* - List installed hooks
22+
* *hook:make* - Make a hook
23+
* *hook:setup* - Prepare Composer for using Hooks
24+
* *hook:uninstall* - Uninstall a hook
25+
* *hook:update* - Update one or more hooks

0 commit comments

Comments
 (0)