Skip to content
This repository has been archived by the owner on Jul 7, 2020. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mzur committed Aug 14, 2019
1 parent dad5c2f commit a068b47
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# BIIGLE Label Trees Module

Install the module:

Add the following to the repositories array of your `composer.json`:
```
{
"type": "vcs",
"url": "[email protected]:biigle/label-trees.git"
}
```

1. Run `php composer.phar require biigle/label-trees`.
2. Add `'Biigle\Modules\LabelTrees\LabelTreesServiceProvider'` to the `providers` array in `config/app.php`.
3. Run `php artisan label-trees:publish` to refresh the public assets of this package. Do this for every update of the package.
This is the BIIGLE module to create, edit and manage label trees.

## Installation

1. Run `composer config repositories.label-trees vcs [email protected]:biigle/label-trees.git`
2. Run `composer require biigle/label-trees`.
3. Add `Biigle\Modules\LabelTrees\LabelTreesServiceProvider::class` to the `providers` array in `config/app.php`.
4. Run `php artisan vendor:publish --tag=public` to publish the public assets of this module.

## Developing

Take a look at the [development guide](https://github.com/biigle/core/blob/master/DEVELOPING.md) of the core repository to get started with the development setup.

Want to develop a new module? Head over to the [biigle/module](https://github.com/biigle/module) template repository.

## Contributions and bug reports

Contributions to BIIGLE are always welcome. Check out the [contribution guide](https://github.com/biigle/core/blob/master/CONTRIBUTING.md) to get started.

0 comments on commit a068b47

Please sign in to comment.