/ README.md
README.md
  1  [![GitHub release](https://img.shields.io/github/release/PurpleI2P/i2pd.svg?label=latest%20release)](https://github.com/PurpleI2P/i2pd/releases/latest)
  2  [![Snapcraft release](https://snapcraft.io/i2pd/badge.svg)](https://snapcraft.io/i2pd)
  3  [![License](https://img.shields.io/github/license/PurpleI2P/i2pd.svg)](https://github.com/PurpleI2P/i2pd/blob/openssl/LICENSE)
  4  [![Packaging status](https://repology.org/badge/tiny-repos/i2pd.svg)](https://repology.org/project/i2pd/versions)
  5  [![Docker Pulls](https://img.shields.io/docker/pulls/purplei2p/i2pd)](https://hub.docker.com/r/purplei2p/i2pd)
  6  [![Github Downloads](https://img.shields.io/github/downloads/PurpleI2P/i2pd/total.svg)]()
  7  [![Crowdin](https://badges.crowdin.net/i2pd/localized.svg)](https://crowdin.com/project/i2pd)
  8  
  9  *Note: i2pd for Android can be found in the [i2pd-android](https://github.com/PurpleI2P/i2pd-android) repository and with a Qt GUI in the [i2pd-qt](https://github.com/PurpleI2P/i2pd-qt) repository. For macOS, a GUI version can be found in the [gui-i2pd](https://github.com/MetanoicArmor/gui-i2pd) repository.*
 10  
 11  i2pd
 12  ====
 13  
 14  [Русская версия](https://github.com/PurpleI2P/i2pd_docs_ru/blob/master/README.md)
 15  
 16  i2pd (I2P Daemon) is a full-featured C++ implementation of I2P client.  
 17  
 18  I2P (Invisible Internet Protocol) is a universal anonymous network layer.  
 19  All communications over I2P are anonymous and end-to-end encrypted, participants
 20  don't reveal their real IP addresses.  
 21  
 22  I2P client is a software used for building and using anonymous I2P
 23  networks. Such networks are commonly used for anonymous peer-to-peer
 24  applications (filesharing, cryptocurrencies) and anonymous client-server
 25  applications (websites, instant messengers, chat-servers).  
 26  
 27  I2P allows people from all around the world to communicate and share information
 28  without restrictions.  
 29  
 30  Features
 31  --------
 32  
 33  * Distributed anonymous networking framework  
 34  * End-to-end encrypted communications  
 35  * Small footprint, simple dependencies, fast performance  
 36  * Rich set of APIs for developers of secure applications  
 37  
 38  Resources
 39  ---------
 40  
 41  * [Website](http://i2pd.website)
 42  * [Documentation](https://i2pd.readthedocs.io/en/latest/)
 43  * [Wiki](https://github.com/PurpleI2P/i2pd/wiki)
 44  * [Tickets/Issues](https://github.com/PurpleI2P/i2pd/issues)
 45  * [Specifications](https://geti2p.net/spec)
 46  * [Twitter](https://twitter.com/hashtag/i2pd)
 47  
 48  Installing
 49  ----------
 50  
 51  The easiest way to install i2pd is by using precompiled packages and binaries.
 52  You can fetch most of them on [release](https://github.com/PurpleI2P/i2pd/releases/latest) page.  
 53  Please see [documentation](https://i2pd.readthedocs.io/en/latest/user-guide/install/) for more info.
 54  
 55  Building
 56  --------
 57  See [documentation](https://i2pd.readthedocs.io/en/latest/) for how to build
 58  i2pd from source on your OS.  
 59  
 60  note: i2pd with Qt GUI can be found in [i2pd-qt](https://github.com/PurpleI2P/i2pd-qt) repository and for android in [i2pd-android](https://github.com/PurpleI2P/i2pd-android) repository.
 61  
 62  
 63  Build instructions:
 64  
 65  * [unix](https://i2pd.readthedocs.io/en/latest/devs/building/unix/)
 66  * [windows](https://i2pd.readthedocs.io/en/latest/devs/building/windows/)
 67  * [iOS](https://i2pd.readthedocs.io/en/latest/devs/building/ios/)
 68  * [android](https://i2pd.readthedocs.io/en/latest/devs/building/android/)
 69  
 70  
 71  **Supported systems:**
 72  
 73  * GNU/Linux (Debian, Ubuntu, etc) - [![Build on Ubuntu](https://github.com/PurpleI2P/i2pd/actions/workflows/build.yml/badge.svg)](https://github.com/PurpleI2P/i2pd/actions/workflows/build.yml)
 74  * CentOS, Fedora, Mageia - [![Build Status](https://copr.fedorainfracloud.org/coprs/supervillain/i2pd/package/i2pd-git/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/supervillain/i2pd/package/i2pd-git/)
 75  * Alpine, ArchLinux, openSUSE, Gentoo, etc.
 76  * Windows - [![Build on Windows](https://github.com/PurpleI2P/i2pd/actions/workflows/build-windows.yml/badge.svg)](https://github.com/PurpleI2P/i2pd/actions/workflows/build-windows.yml)
 77  * Mac OS - [![Build on OSX](https://github.com/PurpleI2P/i2pd/actions/workflows/build-osx.yml/badge.svg)](https://github.com/PurpleI2P/i2pd/actions/workflows/build-osx.yml)
 78  * Docker image - [![Build containers](https://github.com/PurpleI2P/i2pd/actions/workflows/docker.yml/badge.svg)](https://github.com/PurpleI2P/i2pd/actions/workflows/docker.yml)
 79  * Snap - [![i2pd](https://snapcraft.io/i2pd/badge.svg)](https://snapcraft.io/i2pd) [![i2pd](https://snapcraft.io/i2pd/trending.svg?name=0)](https://snapcraft.io/i2pd)
 80  * FreeBSD - [![Build on FreeBSD](https://github.com/PurpleI2P/i2pd/actions/workflows/build-freebsd.yml/badge.svg)](https://github.com/PurpleI2P/i2pd/actions/workflows/build-freebsd.yml)
 81  * Android
 82  * iOS
 83  
 84  Using i2pd
 85  ----------
 86  
 87  See [documentation](https://i2pd.readthedocs.io/en/latest/user-guide/run/) and
 88  [example config file](https://github.com/PurpleI2P/i2pd/blob/openssl/contrib/i2pd.conf).
 89  
 90  Localization
 91  ------------
 92  
 93  You can help us with translation i2pd to your language using Crowdin platform!
 94  Translation project can be found [here](https://crowdin.com/project/i2pd).
 95  
 96  New languages can be requested on project's [discussion page](https://crowdin.com/project/i2pd/discussions).
 97  
 98  Current status: [![Crowdin](https://badges.crowdin.net/i2pd/localized.svg)](https://crowdin.com/project/i2pd)
 99  
100  Donations
101  ---------
102  
103  **E-Mail**: ```i2porignal at yandex.com```
104  
105  **BTC**: ```3MDoGJW9TLMTCDGrR9bLgWXfm6sjmgy86f```
106  
107  **LTC**: ```LKQirrYrDeTuAPnpYq5y7LVKtywfkkHi59```
108  
109  **ETH**: ```0x9e5bac70d20d1079ceaa111127f4fb3bccce379d```
110  
111  **GST**: ```GbD2JSQHBHCKLa9WTHmigJRpyFgmBj4woG```
112  
113  **DASH**: ```Xw8YUrQpYzP9tZBmbjqxS3M97Q7v3vJKUF```
114  
115  **ZEC**: ```t1cTckLuXsr1dwVrK4NDzfhehss4NvMadAJ```
116  
117  **ANC**: ```AQJYweYYUqM1nVfLqfoSMpUMfzxvS4Xd7z```
118  
119  **XMR**: ```497pJc7X4xqKvcLBLpSUtRgWqMMyo24u4btCos3cak6gbMkpobgSU6492ztUcUBghyeHpYeczB55s38NpuHoH5WGNSPDRMH```
120  
121  License
122  -------
123  
124  This project is licensed under the BSD 3-clause license, which can be found in the file
125  LICENSE in the root of the project source code.