This repository has been archived by the owner on Dec 11, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d12c258
commit 01b168a
Showing
1 changed file
with
13 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,23 +7,27 @@ This is a plugin for [netz98 Magerun2](https://github.com/netz98/n98-magerun2) t | |
|
||
## Installation | ||
|
||
### For your OS-user | ||
The preferred way of installing `bitexpert/magerun2-list-api-endpoints` is through Composer. | ||
Simply add `bitexpert/magerun2-list-api-endpoints` as a dev dependency: | ||
|
||
``` | ||
composer.phar require --dev bitexpert/magerun2-list-api-endpoints | ||
``` | ||
|
||
n98-magerun2 will automatically load the plugins laying under `~/.n98-magerun2/modules` (create this folder if it does not exist). | ||
### Local installation | ||
|
||
To add this command, simply clone the repository. | ||
If you do not want to add the command to one specific project only, you can install the plugin globally by placing the | ||
code in the `~/.n98-magerun2/modules` directory. If the folder does not already exist in your setup, create the folder | ||
by running the following command: | ||
|
||
``` | ||
git clone [email protected]:bitExpert/magerun2-list-api-endpoints.git ~/.n98-magerun2/modules/magerun2-list-api-endpoints | ||
mkdir -p ~/.n98-magerun2/modules | ||
``` | ||
|
||
### For specific projects | ||
|
||
The preferred way of installing `bitexpert/magerun2-list-api-endpoints` is through Composer. | ||
Simply add `bitexpert/magerun2-list-api-endpoints` as a dev dependency: | ||
The next thing to do is to clone the repository in a subdirectory of `~/.n98-magerun2/modules`: | ||
|
||
``` | ||
composer.phar require --dev bitexpert/magerun2-list-api-endpoints | ||
git clone [email protected]:bitExpert/magerun2-list-api-endpoints.git ~/.n98-magerun2/modules/magerun2-list-api-endpoints | ||
``` | ||
|
||
## Usage | ||
|