update readme

This commit is contained in:
Zlatin Balevsky
2019-05-30 15:42:06 +01:00
parent b58628c391
commit ef1cf088ca

View File

@@ -4,7 +4,7 @@ MuWire is an easy to use file-sharing program which offers anonymity using [I2P
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.
The project is in development. You can find technical documentation in the "doc" folder.
### Building
@@ -14,7 +14,7 @@ You need Gradle and a JDK 8 or newer. After installing those and setting up the
gradle build
```
And that will build the "pinger", "host-cache" and "core" sub-projects.
And that will build the "pinger", "host-cache", "core" and "gui" sub-projects.
### Pinger sub-project
@@ -25,4 +25,7 @@ This is a simple command-line utility that sends a datagram with specified paylo
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.
This is the headless core / backend of MuWire.
### GUI sub-project
This is the Swing GUI. It is under active development and not yet hooked up to the core.