diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..4376c57 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,12 @@ +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * requiring a full dedicated domain ? + * architectures not supported ? + * not-working single-sign on or LDAP integration ? + * the app requires an important amount of RAM / disk / .. to install or to work properly + * etc... + +* Other infos that people should be aware of, such as: + * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) + * how to configure / administrate the application if it ain't obvious + * upgrade process / specificities / things to be aware of ? + * security considerations ? diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/screenshots/example.jpg b/doc/screenshots/example.jpg new file mode 100644 index 0000000..a1efa1a Binary files /dev/null and b/doc/screenshots/example.jpg differ diff --git a/manifest.json b/manifest.json index df92142..2deafbd 100644 --- a/manifest.json +++ b/manifest.json @@ -1,6 +1,6 @@ { - "name": "YunoHost example app", - "id": "ynhexample", + "name": "Example app", + "id": "example", "packaging_format": 1, "description": { "en": "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)", @@ -8,11 +8,18 @@ }, "version": "1.0~ynh1", "url": "https://example.com", + "upstream": { + "license": "free", + "website": "https://example.com", + "demo": "https://demo.example.com", + "admindoc": "https://yunohost.org/packaging_apps", + "userdoc": "https://yunohost.org/apps", + "code": "https://some.forge.com/example/example" + }, "license": "free", "maintainer": { "name": "John doe", - "email": "john.doe@example.com", - "url": "http://example.com" + "email": "john.doe@example.com" }, "requirements": { "yunohost": ">= 4.1.3"