onionr/README.md

49 lines
1.7 KiB
Markdown
Raw Normal View History

2018-03-03 09:38:27 +00:00
![Onionr logo](./docs/onionr-logo.png)
2018-09-07 04:57:10 +00:00
v0.3.0 (***experimental, not safe or easy to use yet***)
2018-04-01 06:40:31 +00:00
[![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)
2018-03-03 09:31:57 +00:00
Anonymous P2P platform, using Tor & I2P.
<hr>
2018-07-13 05:48:19 +00:00
**The main repo for this software is at https://gitlab.com/beardog/Onionr/**
# Summary
Onionr is a decentralized, peer-to-peer data storage network, designed to be anonymous and resistant to (meta)data analysis and spam.
Onionr can be used for mail, as a social network, instant messenger, file sharing software, or for encrypted group discussion.
# Roadmap/features
2018-02-21 03:17:24 +00:00
2018-07-13 05:48:19 +00:00
Check the [Gitlab Project](https://gitlab.com/beardog/Onionr/milestones/1) to see progress towards the alpha release.
2018-05-19 05:56:26 +00:00
## Core internal features
2018-02-21 03:17:24 +00:00
* [X] Fully p2p/decentralized, no trackers or other single points of failure
* [X] End to end encryption of user data
2018-02-21 03:17:24 +00:00
* [X] Optional non-encrypted blocks, useful for blog posts or public file sharing
* [X] Easy API system for integration to websites
* [ ] Metadata analysis resistance (being improved)
2018-02-21 03:17:24 +00:00
## Other features
**Onionr API and functionality is subject to non-backwards compatible change during pre-alpha development**
2018-01-20 07:23:09 +00:00
## Help out
2018-02-07 09:04:58 +00:00
Everyone is welcome to help out. Please get in touch first if you are making non-trivial changes. If you can't help with programming, you can write documentation or guides.
2018-04-01 06:40:31 +00:00
Bitcoin/Bitcoin Cash: 1onion55FXzm6h8KQw3zFw2igpHcV7LPq
2018-01-20 07:23:09 +00:00
## Disclaimer
The Tor Project, I2P developers, and anyone else do not own, create, or endorse this project, and are not otherwise involved.
2018-04-01 06:40:31 +00:00
2018-09-07 04:57:10 +00:00
The badges (besides travis-ci build) are by Maik Ellerbrock is licensed under a Creative Commons Attribution 4.0 International License.