douzeb/garage_ynh
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #17 from YunoHost/upgrade_readme

Browse source 
[enh] Update readme
This commit is contained in:
M5oul 2017-02-17 13:28:38 +01:00 committed by GitHub
parent 8f195a7ef8 5ae7d82535
commit d616f5ac06
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,11 +1,22 @@
# YunoHost example app
# Example app for YunoHost
- [Yunohost project](https://yunohost.org)
- [Exemple app website](https://example.com)
Description of the app.
## Usage
- Add application source files into `sources` subfolder.
- Copy this app before work on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit manifest with application specific information.
- Edit the install, upgrade, remove, backup, restore scripts.
- Add a LICENSE file for the package.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Add a `LICENSE` file for the package.
- Edit `README.md`.
**More information on the documentation page:**
https://yunohost.org/packaging_apps
**Upgrade this package:**
`sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh`
**Multi-user:** Yes/No. How about the ldap and HTTP auth support.