-
Notifications
You must be signed in to change notification settings - Fork 1
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
Nabeel Shahzad
committed
Feb 28, 2020
1 parent
f992022
commit 6332c03
Showing
2 changed files
with
36 additions
and
10 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 |
---|---|---|
@@ -1,12 +1,36 @@ | ||
# phpvms-plugin | ||
# phpvms-module | ||
|
||
Sample/template repository for a phpVMS plugin. | ||
Sample/template repository for a phpVMS plugin. See the full docs here: http://docs.phpvms.net/developers/add-ons-and-modules | ||
|
||
## Generating a new module | ||
|
||
The easiest way to generate a new module for phpVMS is to use the `artisan` command: | ||
|
||
``` | ||
php artisan module:make {ModuleName} | ||
``` | ||
|
||
That will create a module in the `modules` folder, which you can then copy out into its own repository and develop. | ||
|
||
## Composer Configuration | ||
|
||
The `type` field needs to be set to "phpvms-plugin", and | ||
### Type | ||
|
||
The `type` field needs to be set to "phpvms-module", and | ||
|
||
```json | ||
"type": "phpvms-plugin", | ||
"type": "phpvms-module", | ||
"require": {} | ||
``` | ||
|
||
### Autoload | ||
|
||
The path to your namespace must be set by the `autoload` section: | ||
|
||
```json | ||
"autoload": { | ||
"psr-4": { | ||
"Modules\\Sample\\": "." | ||
} | ||
} | ||
``` |
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