Merge pull request #109 from comradekingu/patch-1

example_ynh readme reworked

README.md

@@ -1,11 +1,11 @@
 # Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
 - Copy this app before working on it.
-- Edit `conf/nginx.conf` file to match application prerequisites.
+- Edit the `conf/nginx.conf` file to match app prerequisites.
-- Edit `manifest.json` with application specific information.
+- Edit the `manifest.json` with app specific info.
 - Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
   - Using the [script helpers documentation.](https://yunohost.org/#/packaging_apps_helpers)
 - Add a `LICENSE` file for the package.
-- Edit `README.md` and README_fr.md.
+- Edit `README.md` and `README_fr.md`.
 
 # Example app for YunoHost
 
@@ -14,8 +14,8 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.  
+> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.  
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
 Quick description of this app.
@@ -24,15 +24,15 @@ Quick description of this app.
 
 ## Screenshots
 
-![](Link to an screenshot for this app)
+![](Link to a screenshot of this app.)
 
 ## Demo
 
-* [Official demo](Link to a demo site for this app)
+* [Official demo](Link to a demo site for this app.)
 
 ## Configuration
 
-How to configure this app: by an admin panel, a plain file with SSH, or any other way.
+How to configure this app: From an admin panel, a plain file with SSH, or any other way.
 
 ## Documentation
 
@@ -41,14 +41,14 @@ How to configure this app: by an admin panel, a plain file with SSH, or any othe
 
 ## YunoHost specific features
 
-#### Multi-users support
+#### Multi-user support
 
 Are LDAP and HTTP auth supported?
 Can the app be used by multiple users?
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
 * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
 
 ## Limitations
@@ -57,25 +57,25 @@ Can the app be used by multiple users?
 
 ## Additional information
 
-* Other information you would add about this application
+* Other info you would like to add about this app.
 
-**More information on the documentation page:**  
+**More info on the documentation page:**  
 https://yunohost.org/packaging_apps
 
 ## Links
 
  * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
- * App website: Link to the official website of this app
+ * App website: Link to the official website of this app.
- * Upstream app repository: Link to the official repository of the upstream app
+ * Upstream app repository: Link to the official repository of the upstream app.
  * YunoHost website: https://yunohost.org/
 
 ---
 
-Developers info
+Developer info
 ----------------
 
 **Only if you want to use a testing branch for coding, instead of merging directly into master.**
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```