Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-07 12:54:31 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added basic custom modules docs

Browse Source
This commit is contained in:
Hillel Coren 2016-12-07 23:17:28 +02:00
parent 0571e91ee3
commit d831d7969b
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/custom_modules.rst
View File

@ -8,19 +8,19 @@ Install Module
To install a module run: To install a module run:
.. code-block:: ruby .. code-block:: php
php artisan module:install <vendor/module> --type=github php artisan module:install <vendor/module> --type=github
For example: For example:
.. code-block:: ruby .. code-block:: php
php artisan module:install invoiceninja/sprockets --type=github php artisan module:install invoiceninja/sprockets --type=github
You can check the current module status with: You can check the current module status with:
.. code-block:: ruby .. code-block:: php
php artisan module:list php artisan module:list
@ -30,7 +30,7 @@ Create Module
Run the following command to create a module: Run the following command to create a module:
.. code-block:: ruby .. code-block:: php
php artisan module:make <module> php artisan module:make <module>
@ -43,7 +43,7 @@ Share Module
To share your module create a new project on GitHub and then commit the code: To share your module create a new project on GitHub and then commit the code:
.. code-block:: ruby .. code-block:: php
cd Modules/<module> cd Modules/<module>
git init git init
@ -54,4 +54,4 @@ To share your module create a new project on GitHub and then commit the code:
.. Tip:: Add ``"type": "invoiceninja-module"`` to the composer.json file to help people find your module. .. Tip:: Add ``"type": "invoiceninja-module"`` to the composer.json file to help people find your module.
Finally, submit the project to https://packagist.org. Finally, submit the project to https://packagist.org.