README.md

# MuWire - Easy Anonymous File-Sharing

MuWire is an easy to use file-sharing program which offers anonymity using [I2P technology](http://geti2p.net).

It is inspired by the LimeWire Gnutella client and developped by a former LimeWire developer.

The project is in early planning stage.  You can find technical documentation in the "doc" folder.

### Building

You need Gradle and a JDK 8 or newer.  After installing those and setting up the appropriate paths, just type

```
gradle build
```

And that will build the "pinger", "host-cache" and "core" sub-projects.

### Pinger sub-project

This is a simple command-line utility that sends a datagram with specified payload to a specified destination and prints out any responses

### Host-Cache sub-project

This is the bootstrap server (aka "HostCache") that MuWire uses.  It listens for incoming Pings from MuWire nodes and responds with other nodes to connect to.  In addition, it "crawls" the network to discover live nodes.

### Core sub-project
This is the headless core / backend of MuWire.  At the moment this just queries a HostCache on startup.
brief intro 2018-07-02 13:52:15 +01:00			`# MuWire - Easy Anonymous File-Sharing`

Point to I2P site and doc folder 2018-07-02 15:54:52 +01:00			`MuWire is an easy to use file-sharing program which offers anonymity using [I2P technology](http://geti2p.net).`
brief intro 2018-07-02 13:52:15 +01:00
			`It is inspired by the LimeWire Gnutella client and developped by a former LimeWire developer.`
Point to I2P site and doc folder 2018-07-02 15:54:52 +01:00
document pinger and host-cache subprojects 2018-07-15 08:31:01 +01:00			`The project is in early planning stage. You can find technical documentation in the "doc" folder.`

			`### Building`

			`You need Gradle and a JDK 8 or newer. After installing those and setting up the appropriate paths, just type`

			```
			`gradle build`
			```

update README for core project 2018-07-26 01:06:32 +01:00			`And that will build the "pinger", "host-cache" and "core" sub-projects.`
document pinger and host-cache subprojects 2018-07-15 08:31:01 +01:00
			`### Pinger sub-project`

			`This is a simple command-line utility that sends a datagram with specified payload to a specified destination and prints out any responses`

			`### Host-Cache sub-project`

update README for core project 2018-07-26 01:06:32 +01:00			`This is the bootstrap server (aka "HostCache") that MuWire uses. It listens for incoming Pings from MuWire nodes and responds with other nodes to connect to. In addition, it "crawls" the network to discover live nodes.`

			`### Core sub-project`
			`This is the headless core / backend of MuWire. At the moment this just queries a HostCache on startup.`