Improve documentations

.github/workflows/main.yml

@@ -10,6 +10,7 @@ on:
     branches:
       - master
     paths-ignore:
+      -'doc/'
       -'fastlane/**'
       -'README.md'
   workflow_dispatch:

README.md

@@ -45,18 +45,18 @@ It helps you to take your privacy back!
 ## Contributing
 
 If you want to help us improve this application, you can:
-- [Translate app](https://github.com/Exodus-Privacy/exodus-android-app#translation)
-- Use [the issues](https://github.com/Exodus-Privacy/exodus-android-app/issues) to report bugs and propose ideas or feature requests
+- [Translate the app](https://github.com/Exodus-Privacy/exodus-android-app#translation)
+- Use [issues](https://github.com/Exodus-Privacy/exodus-android-app/issues) to report bugs and propose ideas or feature requests
 - Join us on our [IRC channel #exodus-android-app on Libera.chat](https://web.libera.chat/?nick=webguest?#exodus-android-app)
 
 
 ### Translation
 
-Do you want to help translate the application? Contribute here:
+Do you want to help to translate the application? Contribute here:
 
 https://crowdin.com/project/exodus-android-app
 
-- Exodus is fully translated into 2 languages and 36 languages can be translated in Crowdin.
+- Exodus is fully translated into 5 languages and 27 languages can be translated in Crowdin.
 - You can translate the app on Github but don't forget to insert a backslash `\` before any apostrophe `'`.
 
 ### Development
@@ -99,3 +99,4 @@ https://crowdin.com/project/exodus-android-app
 - [Privacy-Policy](https://exodus-privacy.eu.org/en/page/privacy-policy/)
 - [Documentation](https://github.com/Exodus-Privacy/exodus-android-app/tree/master/doc)
 - [REST API Documentation](https://github.com/Exodus-Privacy/exodus/blob/v1/doc/api.md)
+- [FDroid Build Metadata file](https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/org.eu.exodus_privacy.exodusprivacy.yml)

doc/RELEASE.md

@@ -0,0 +1,11 @@
+# Create and push a release
+
+This file explain how create a new release of the app.
+
+1. Increase `versionCode` and `versionName` in [app/build.gradle.kts](/app/build.gradle.kts)
+2. Add english and french changelogs in [fastlane/metadata/android/en-US/changelogs](/fastlane/metadata/android/en-US/changelogs) and [fastlane/metadata/android/fr-FR/changelogs](/fastlane/metadata/android/fr-FR/changelogs) with versionCode like name of the file.
+3. Push these changes on master
+4. Create and push a tag following this format `release-v` + versionName
+5. The [release workflow](/.github/workflows/release.yml) is automatically triggered which creates a new release on Github, generates automatically a changelog, and uploads an APK on the Github release.
+
+To follow publication on FDroid, you can check the FDroid robot have update [Build Metadata file](https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/org.eu.exodus_privacy.exodusprivacy.yml) and check build is in success [on F-Droid Monitor](https://monitor.f-droid.org/builds/build).