Skip to content

Commit

Permalink
Merge pull request #359 from qstokkink/update_readme
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
qstokkink authored Nov 13, 2018
2 parents 8bff206 + 18832b3 commit 20e53eb
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## What is IPv8 ?

IPv8 aims to provide authenticated communication with privacy.
This Python 2/3 package is an amalgamation of peer-to-peer communication functionality from [Dispersy](https://github.com/Tribler/dispersy) and [Tribler](https://github.com/Tribler/tribler), developed over the last 13 years by students and employees of the Delft University of Technology.
The IPv8 library allows you to easily create network overlays on which to build your own applications.

### IPv8 Objectives

Expand All @@ -12,21 +14,6 @@ IPv8 aims to provide authenticated communication with privacy.
- **NAT traversal**. IPv8 can establish direct communication in difficult network situations. This includes connecting people behind a NAT or firewall. IPv8 includes a single simple and effective NAT traversal technique: UDP hole-punching. This is essential when offering privacy without infrastructure and consumer-grade donated resources.
- **Trust**. You can enhance your security if you tell IPv8 which people you know and trust. It tries to build a web-of-trust automatically.

This Python 2 package contains IPv8: an amalgamation of peer-to-peer communication functionality from [Dispersy](https://github.com/Tribler/dispersy) and [Tribler](https://github.com/Tribler/tribler), developed over the last 13 years by students and employees of the Delft University of Technology.
The IPv8 library allows you to interface with the existing Dispersy network to build your own applications.

Functionality included by IPv8 at this point is:
- *Cryptographically signed messaging*
- *Tor-like anonymous messaging*
- *Public service discovery*
- *Hidden service discovery*
- *TrustChain self-sovereign blockchain*
- *Peer discovery using random walks and (sybil resistant) edge walks*
- *Peer keep-alive mechanisms*
- *Hidden attribute attestation*

Implementations on the horizon of this library are *stream-based messaging* (instead of packet-based), *scalable TrustChain concensus* and *mixnet functionality*.

### Dependencies
The dependencies for IPv8 are collected in the `requirements.txt` file and can be installed using `pip`:

Expand Down

0 comments on commit 20e53eb

Please sign in to comment.