kev/Onionr
1
0
Fork 0
Code Issues 24 Pull Requests Projects Releases 2 Wiki Activity

correct readme to current status

Browse Source
This commit is contained in:
Kevin F 2022-08-16 10:46:23 -05:00
parent b59e79a21f
commit 189645d560
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -27,7 +27,7 @@
***Note that this README reflects the state of the rewrite, and not the original alpha network*** ***Note that this README reflects the state of the rewrite, and not the original alpha network***
Mirrors [Gitlab](https://gitlab.com/beardog/onionr) Mirrors [Gitlab](https://git.voidnet.tech/onionr)
Onionr ("Onion Relay") is a decentralized/distributed peer-to-peer communication network, designed to be anonymous and resistant to (meta)data analysis, spam, and corruption. Onionr ("Onion Relay") is a decentralized/distributed peer-to-peer communication network, designed to be anonymous and resistant to (meta)data analysis, spam, and corruption.
@ -86,7 +86,7 @@ Master may be unstable, you should use the latest release tag. (checkout via git
* Have python3.7+, python3-pip, Tor (daemon, not browser) installed. python3-dev is recommended. * Have python3.7+, python3-pip, Tor (daemon, not browser) installed. python3-dev is recommended.
* You may need build-essentials or the equivalent of your platform * You may need build-essentials or the equivalent of your platform
* Clone the git repo: `$ git clone https://gitlab.com/beardog/onionr --tags` * Clone the git repo: `$ git clone https://git.voidnet.tech/onionr --tags`
* cd into install direction: `$ cd onionr/` * cd into install direction: `$ cd onionr/`
* Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install --require-hashes -r requirements.txt` (on ARM64 devices like Raspberry Pi 4's use requirements-ARM.txt instead.) * Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install --require-hashes -r requirements.txt` (on ARM64 devices like Raspberry Pi 4's use requirements-ARM.txt instead.)
* (Optional): Install desktop notification dependencies: `$ pip3 install --require-hashes -r requirements-notifications.txt` * (Optional): Install desktop notification dependencies: `$ pip3 install --require-hashes -r requirements-notifications.txt`

20
ROADMAP.md
View File

@ -6,32 +6,32 @@
* [ X ] Implement new block format with verifiable delay function * [ X ] Implement new block format with verifiable delay function
* [ ] Implement overhauled gossip system with dandelion++ * [ X ] Implement overhauled gossip system with dandelion++
The new system is separated from the underlying networks used and makes it much easier to implement new transport methods. Dandelion++ is also better than the old block mixing we did. The new system is separated from the underlying networks used and makes it much easier to implement new transport methods. Dandelion++ is also better than the old block mixing we did.
* [ ] Revamped key/encrypted messaging (encrypted blocks)
* [ ] Restore webUI as a plugin
* [ ] Restore static site/file sharing plugin
* [ ] Restore/reimplement mail plugin
* [ ] Restore/reimplement friends plugin
* [ ] Refresh test suite
## Misc ## Misc
* [ ] Spruce up documentation * [ ] Spruce up documentation
* [ ] Restore LAN transport * [ ] Restore LAN transport
* [ ] Restore webUI as a plugin
* [ ] Restore static site/file sharing plugin
* [ ] Restore/reimplement mail plugin
* [ ] Restore/reimplement friends plugin
* [ ] Refresh test suite
* [ ] Revamped key/encrypted messaging (encrypted blocks)
## Web of trust release (10.0)
## Web of trust release (~10.0)
To facilitate the below market plugin/application, Onionr will need a web of trust system. To facilitate the below market plugin/application, Onionr will need a web of trust system.
* [ ] Web of trust plugin or module * [ ] Web of trust plugin or module
## Market Plugin Release (10.1) ## Market Plugin Release (~10.1)
The Onionr team believes the Monero community is currently lacking a good p2p market, and as such we hope to build a solution using Onionr as a transport. This may be a separate project and as opposed to a plugin. The Onionr team believes the Monero community is currently lacking a good p2p market, and as such we hope to build a solution using Onionr as a transport. This may be a separate project and as opposed to a plugin.