Pārlūkot izejas kodu

[enh] markdown syntax.

Moul 8 gadi atpakaļ
vecāks
revīzija
7a8c0d9e00
1 mainītis faili ar 6 papildinājumiem un 8 dzēšanām
  1. 6 8
      README.md

+ 6 - 8
README.md

@@ -1,11 +1,9 @@
-Example app for YunoHost
-==================
+# Example app for YunoHost
 
-[Yunohost project](https://yunohost.org/#/)
+- [Yunohost project](https://yunohost.org)
+- [Exemple app website](https://example.com)
 
-Small description of the app
-
-https://example.com
+Description of the app.
 
 ## Usage
 - Fork this app before work on it.
@@ -13,13 +11,13 @@ https://example.com
 - 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.
+- Add a `LICENSE` file for the package.
 - Edit this readme.
 
 **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
+`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.