Browse Source

More informative README and docs index

pull/520/head
libre-net-society 9 years ago
parent
commit
5be147e8cc
  1. 60
      README.md
  2. 32
      docs/index.rst

60
README.md

@ -1,38 +1,54 @@
i2pd i2pd
==== ====
Independent C++ implementation of I2P router i2pd is a full-featured C++ implementation of
[I2P](https://geti2p.net/en/about/intro) client.
License I2P (Invisible Internet Project) is anonymous network which works on top of
------- public Internet. Privacy and anonymity are achieved by strong encryption and
bouncing your traffic through thousands of I2P nodes all around the world.
This project is licensed under the BSD 3-clause license, which can be found in the file We are building network which helps people to communicate and share information
LICENSE in the root of the project source code. without restrictions.
Donations * [Website](http://i2pd.website)
--------- * [Documentation](https://i2pd.readthedocs.io/en/latest/)
* [Wiki](https://github.com/PurpleI2P/i2pd/wiki)
* [Tickets/Issues](https://github.com/PurpleI2P/i2pd/issues)
* [Twitter](https://twitter.com/i2porignal)
BTC: 1K7Ds6KUeR8ya287UC4rYTjvC96vXyZbDY Installing
LTC: LKQirrYrDeTuAPnpYq5y7LVKtywfkkHi59 ----------
ANC: AQJYweYYUqM1nVfLqfoSMpUMfzxvS4Xd7z
DOGE: DNXLQKziRPAsD9H3DFNjk4fLQrdaSX893Y
Documentation: The easiest way to install i2pd is by using
-------------- [precompiled binaries](https://github.com/PurpleI2P/i2pd/releases/latest).
http://i2pd.readthedocs.org See [documentation](https://i2pd.readthedocs.io/en/latest/) for how to build
i2pd from source on your OS.
Supported OS **Supported systems:**
------------
* Linux x86/x64 - [![Build Status](https://travis-ci.org/PurpleI2P/i2pd.svg?branch=openssl)](https://travis-ci.org/PurpleI2P/i2pd) * Linux x86/x64 - [![Build Status](https://travis-ci.org/PurpleI2P/i2pd.svg?branch=openssl)](https://travis-ci.org/PurpleI2P/i2pd)
* Windows - [![Build status](https://ci.appveyor.com/api/projects/status/1908qe4p48ff1x23?svg=true)](https://ci.appveyor.com/project/PurpleI2P/i2pd) * Windows - [![Build status](https://ci.appveyor.com/api/projects/status/1908qe4p48ff1x23?svg=true)](https://ci.appveyor.com/project/PurpleI2P/i2pd)
* Mac OS X * Mac OS X
* FreeBSD * FreeBSD
* Android *(coming soon)*
Using i2pd
----------
See [documentation](https://i2pd.readthedocs.io/en/latest/) and
[example config file](https://github.com/PurpleI2P/i2pd/blob/openssl/docs/i2pd.conf).
More documentation Donations
------------------ ---------
BTC: 1K7Ds6KUeR8ya287UC4rYTjvC96vXyZbDY
LTC: LKQirrYrDeTuAPnpYq5y7LVKtywfkkHi59
ANC: AQJYweYYUqM1nVfLqfoSMpUMfzxvS4Xd7z
DOGE: DNXLQKziRPAsD9H3DFNjk4fLQrdaSX893Y
License
-------
* [Building from source / unix](docs/build_notes_unix.md) This project is licensed under the BSD 3-clause license, which can be found in the file
* [Building from source / windows](docs/build_notes_windows.md) LICENSE in the root of the project source code.
* [Configuring your i2pd](docs/configuration.md)
* [Github wiki](https://github.com/PurpleI2P/i2pd/wiki/)

32
docs/index.rst

@ -1,20 +1,27 @@
i2pd i2pd
==== ====
`Website <http://i2pd.website>`_ | i2pd is a full-featured C++ implementation of
`Github <https://github.com/PurpleI2P/i2pd>`_ | `I2P <https://geti2p.net/en/about/intro>`_ client.
`Issues <https://github.com/PurpleI2P/i2pd/issues>`_
i2pd is C++ implementation of `I2P <https://geti2p.net/en/about/intro>`_. * `Website <http://i2pd.website>`_
* `GitHub <https://github.com/PurpleI2P/i2pd>`_
* `Wiki <https://github.com/PurpleI2P/i2pd/wiki>`_
* `Tickets/Issues <https://github.com/PurpleI2P/i2pd/issues>`_
* `Twitter <https://twitter.com/i2porignal>`_
Supports: Installing
--------- ----------
* Complete I2P router functionality The easiest way to install i2pd is by using
* Floodfill `precompiled binaries <https://github.com/PurpleI2P/i2pd/releases/latest>`_.
* HTTP and SOCKS proxy See documentation for how to build i2pd from source on your OS.
* I2P client and server tunnels
* SAM and BOB interfaces Using i2pd
----------
See documentation and
`example config file <https://github.com/PurpleI2P/i2pd/blob/openssl/docs/i2pd.conf>`_.
Contents: Contents:
--------- ---------
@ -28,3 +35,4 @@ Contents:
configuration configuration
family family

Loading…
Cancel
Save