From e139581ce075d587e881dcc778df06c372c7d041 Mon Sep 17 00:00:00 2001 From: Doctor Date: Sat, 1 Jun 2024 05:12:10 +0200 Subject: [PATCH] doc: improve readme - add percent localized button - clear contributing list - useful links --- README.md | 50 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7c25e169..38a76fa0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ -# εxodus - -[![Build Status](https://github.com/Exodus-Privacy/exodus/actions/workflows/main.yml/badge.svg?branch=v1)](https://github.com/Exodus-Privacy/exodus/actions/workflows/main.yml) [![CodeQL](https://github.com/Exodus-Privacy/exodus/actions/workflows/codeql.yml/badge.svg)](https://github.com/Exodus-Privacy/exodus/actions/workflows/codeql.yml) +

εxodus

**εxodus** is a privacy auditing platform for Android applications. It detects behaviors which can be dangerous for user privacy like ads, tracking, analytics, … The official instance of εxodus is available [here](https://reports.exodus-privacy.eu.org/). -## Contribute to the identification of trackers - -All data about trackers are stored on [ETIP](https://etip.exodus-privacy.eu.org) (εxodus tracker investigation platform). - -If you wish to help us identify new trackers, you can request an ETIP account by sending a username and an email address to [etip@exodus-privacy.eu.org](mailto:etip@exodus-privacy.eu.org) +

+ + Build Status + + + CodeQL + + + Crowdin + +

## Getting Started @@ -22,18 +26,40 @@ You have different ways of setting up your development environment (via Docker o If you are looking for adding εxodus into your CI pipelines, take a look at [εxodus-standalone](https://github.com/Exodus-Privacy/exodus-standalone). -### FAQ +## Contributing -Check the [FAQ](doc/faq.md) if you encounter any problem or need an extended documentation about εxodus. +Please follow [Exodus Privacy's code of conduct](https://exodus-privacy.eu.org/en/page/coc/). -## Contributing +If you want to help us improve this project, you can: + +- [Translate the plateform](https://github.com/Exodus-Privacy/exodus#translation) +- Use [issues](https://github.com/Exodus-Privacy/exodus/issues) to report bugs and propose ideas or feature requests +- Join us on our [IRC channel #exodus-privacy on Libera.chat](https://web.libera.chat/?nick=webguest?#exodus-privacy) +- Refer to [this documentation](CONTRIBUTING.md) to improve the code. +- [Contribute to the identification of trackers](https://github.com/Exodus-Privacy/exodus#contribute-to-the-identification-of-trackers) + +### Translation -If you want to contribute to this project, you can refer to [this documentation](CONTRIBUTING.md). +Do you want to help to translate the plateform? Contribute here: + +https://crowdin.com/project/exodus-privacy + +- εxodus is fully translated into 6 languages and 33 languages can be translated in Crowdin. + +### Contribute to the identification of trackers + +All data about trackers are stored on [ETIP](https://etip.exodus-privacy.eu.org) (εxodus tracker investigation platform). + +If you wish to help us identify new trackers, you can request an ETIP account by sending a username and an email address to [etip@exodus-privacy.eu.org](mailto:etip@exodus-privacy.eu.org) ## API documentation You can find the εxodus API documentation [here](doc/api.md). +### FAQ + +Check the [FAQ](doc/faq.md) if you encounter any problem or need an extended documentation about εxodus. + ## License This project is licensed under the GNU AGPL v3 License - see the [LICENSE](LICENSE) file for details.