Skip to content

Commit

Permalink
doc: improve readme
Browse files Browse the repository at this point in the history
- add percent localized button
- clear contributing list
- useful links
  • Loading branch information
codeurimpulsif committed Jun 1, 2024
1 parent a5da0ac commit e139581
Showing 1 changed file with 38 additions and 12 deletions.
50 changes: 38 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
<h1 align="center">εxodus</h1>

**ε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 [[email protected]](mailto:[email protected])
<p align="center">
<a href="https://github.com/Exodus-Privacy/exodus/actions/workflows/main.yml">
<img src="https://github.com/Exodus-Privacy/exodus/actions/workflows/main.yml/badge.svg?branch=v1" alt="Build Status"/>
</a>
<a href="https://github.com/Exodus-Privacy/exodus/actions/workflows/codeql.yml">
<img src="https://github.com/Exodus-Privacy/exodus/actions/workflows/codeql.yml/badge.svg" alt="CodeQL"/>
</a>
<a href="https://crowdin.com/project/exodus-privacy">
<img src="https://badges.crowdin.net/exodus-privacy/localized.svg" alt="Crowdin"/>
</a>
</p>

## Getting Started

Expand All @@ -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 [[email protected]](mailto:[email protected])

## 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.

0 comments on commit e139581

Please sign in to comment.