Skip to content
This repository has been archived by the owner on Dec 11, 2021. It is now read-only.

Commit

Permalink
Optimize Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
shochdoerfer committed Jan 23, 2021
1 parent d12c258 commit 01b168a
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 01b168a

Please sign in to comment.