1
0
Fork 0

Document dependencies description

This commit is contained in:
Alan Plum 2016-11-18 15:58:52 +01:00
parent bfda3d4bc0
commit 4585f300d9
No known key found for this signature in database
GPG Key ID: 8ED72A9A323B6EFD
3 changed files with 8 additions and 0 deletions

View File

@ -11,6 +11,12 @@ devel
* Foxx configuration values for unknown options will be discarded when saving the configuration in production mode using the web interface
v3.1.2 (20XX-XX-XX)
-------------------
* added support for descriptions field in Foxx dependencies
v3.1.1 (XXXX-XX-XX)
-------------------

View File

@ -62,6 +62,7 @@ A `dependencies` definition maps the local alias of a given dependency against i
"myAuth": {
"name": "@foxx/auth",
"version": "^1.0.0",
"description": "This description is entirely optional.",
"required": false
}
}

View File

@ -5,6 +5,7 @@ Every service comes with a `manifest.json` file providing metadata. The followin
* **configuration**: `Object` (optional)
An object defining the [configuration options](Configuration.md) this service requires.
<!-- TODO: examples -->
* **defaultDocument**: `string` (optional)