From 989fe3a82d1929ad480ed6d7d250a7422926e121 Mon Sep 17 00:00:00 2001
From: Arthur BOUDREAULT <boudreaultarthur@ik.me>
Date: Tue, 12 Oct 2021 11:01:06 +0200
Subject: [PATCH] =?UTF-8?q?=E2=9C=85feat:=20Split=20readme=20into=20two=20?=
 =?UTF-8?q?docs=20for=20better=20readability=20and=20accessibility?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README-FR.md |  81 +++++++++++++++++++++++++++++++++++++++
 README.md    | 104 +++++----------------------------------------------
 2 files changed, 90 insertions(+), 95 deletions(-)
 create mode 100644 README-FR.md

diff --git a/README-FR.md b/README-FR.md
new file mode 100644
index 0000000..a039300
--- /dev/null
+++ b/README-FR.md
@@ -0,0 +1,81 @@
+# ansible-yunohost
+[🇬🇧 English version](README.md)
+
+Deployez Yunohost avec Ansible !
+
+## Prérequis
+------------
+
+Aucun.
+
+## Role Variables
+--------------
+Les variables par défaut sont disponibles dans `default/main.yml` cependant il est nécessaire de les surcharger selon vos besoins en termes de domaines, d'utilisateurs et d'applications sur Yunohost.
+
+## Exemple de Variables:
+----------------
+```yml
+---
+# Debian 10 script only.
+ynh_install_script_url: https://install.yunohost.org
+
+ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
+
+# The list of domains.
+ynh_main_domain: domain.tld
+ynh_extra_domains: 
+  - forum.domain.tld
+  - wiki.domain.tld
+ynh_ignore_dyndns_server: False
+
+# The list of Yunohost users.
+ynh_users: 
+   - name: user1
+     pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
+     firstname: Jane
+     lastname: Doe 
+     mail_domain: domain.tld 
+
+# The list of Yunohost apps.
+ynh_apps: 
+  - label: WikiJS # Label is important, it's a reference for the Playbook.
+    link: wikijs # It can be the name of an official app or a git repo link.
+    args: # Provide args. Domain and pah are mandatory, for other args read manifest.json of app.
+      domain: wiki.domain.tld
+      path: /
+      admin: user1 
+      is_public: no
+  - label: Discourse
+    link: discourse 
+    args:
+      domain: forum.domain.tld
+      path: /
+      admin: user1 
+      is_public: yes
+```
+## Dépendances
+------------
+
+Aucune.
+
+## Exemple de Playbook
+----------------
+```yml
+---
+- name: Install Yunohost on Debian Server
+  hosts: all
+  become: True
+  pre_tasks:
+    - name: Update all packages and index
+      ansible.builtin.apt:
+        upgrade: dist
+        update_cache: yes
+    
+  roles:
+    - ansible-yunohost
+```
+
+## License
+-------
+
+GPL-3.0
diff --git a/README.md b/README.md
index 08ebd3b..495ae3d 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,19 @@
-ansible-yunohost
-=========
+# ansible-yunohost
+[🇫🇷 French version](README-FR.md)
 
 Deploy Yunohost with Ansible!
 
-Requirements
+## Requirements
 ------------
 
 None.
 
-Role Variables
+## Role Variables
 --------------
 Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps.
 
-Example of Variables:
+## Example of Variables:
+----------------
 ```yml
 ---
 # Debian 10 script only.
@@ -21,9 +22,6 @@ ynh_install_script_url: https://install.yunohost.org
 ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
 
 # The list of domains.
-ynh_main_domain: poclydra.eu
-ynh_extra_domains: 
-  - forum.poclydra.eu
 ynh_main_domain: domain.tld
 ynh_extra_domains: 
   - forum.domain.tld
@@ -56,12 +54,12 @@ ynh_apps:
       is_public: yes
 ```
 
-Dependencies
+## Dependencies
 ------------
 
 None.
 
-Example Playbook
+## Example Playbook
 ----------------
 ```yml
 ---
@@ -78,91 +76,7 @@ Example Playbook
     - ansible-yunohost
 ```
 
-License
+## License
 -------
 
 GPL-3.0
-
--------------------------------------------------------
-
-ansible-yunohost
-=========
-
-Deployez Yunohost avec Ansible !
-
-Prérequis
-------------
-
-Aucun.
-
-Role Variables
---------------
-
-Les variables par défaut sont disponibles dans `default/main.yml` cependant il est nécessaire de les surcharger selon vos besoins en termes de domaines, d'utilisateurs et d'applications sur Yunohost.
-
-
-Exemple de Variables:
-```yml
----
-# Debian 10 script only.
-ynh_install_script_url: https://install.yunohost.org
-
-ynh_admin_password: uo3A2iq4CtkUdt
-
-# The list of domains.
-ynh_main_domain: poclydra.eu
-ynh_extra_domains: 
-  - forum.poclydra.eu
-  - wiki.poclydra.eu
-ynh_ignore_dyndns_server: False
-
-# The list of Yunohost users.
-ynh_users: 
-   - name: user1
-     pass: q97CrbNHJFKuWz
-     firstname: Jane
-     lastname: Doe 
-     mail_domain: poclydra.eu 
-
-# The list of Yunohost apps.
-ynh_apps: 
-  - label: WikiJS # Label is important, it's a reference for the Playbook.
-    link: wikijs # It can be the name of an official app or a git repo link.
-    args: # Provide args. Domain and pah are mandatory, for other args read manifest.json of app.
-      domain: wiki.poclydra.eu
-      path: /
-      admin: user1 
-      is_public: no
-  - label: Discourse
-    link: discourse 
-    args:
-      domain: forum.poclydra.eu
-      path: /
-      admin: user1 
-      is_public: yes
-```
-
-
-Dépendances
-------------
-
-Aucune.
-
-Exemple de Playbook
-----------------
-```yml
----
-- name: Deploy Yunohost on Debian Server
-  hosts: dev
-  become: True
-  tags:
-    - deploy
-    
-  roles:
-    - ansible-yunohost
-```
-
-License
--------
-
-GPL-3.0
\ No newline at end of file
-- 
GitLab