nortega/neocomm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a roadmap to the README.

Browse Source
This commit is contained in:
Nicolás A. Ortega 2017-07-16 21:00:28 -05:00
parent 5c8f883eff
commit dee223e651
No known key found for this signature in database
GPG Key ID: 3D786FB3123FF1DD
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -5,6 +5,7 @@ NeoComm is a completely decentralized and anti-censorship IRC replacement networ
This repository provides a library with interfaces by which you can access the network, which you are able to use in your own software under the terms & conditions of the [library's license](#license). This repository provides a library with interfaces by which you can access the network, which you are able to use in your own software under the terms & conditions of the [library's license](#license).
- [Network Model](#network-model) - [Network Model](#network-model)
- [Roadmap](#roadmap)
- [API Documentation](#api-documentation) - [API Documentation](#api-documentation)
- [Clients](#clients) - [Clients](#clients)
- [Compiling](#compiling) - [Compiling](#compiling)
@ -17,6 +18,27 @@ This model moves further from the federated decentralization model, taking one c
For more information on the network model, please refer to the wiki. For more information on the network model, please refer to the wiki.
Roadmap
-------
What follows is a list roadmap of features and the (approximate) versions in which they will be implemented.
- v0.1-alpha:
- [ ] Node connectivity
- [ ] Messages properly sent and received
- v0.1:
- [ ] Channel functionality
- [ ] Message encryption
- [ ] Sample nodes for testing
- v0.2:
- [ ] Private messages
- v1.0:
- [ ] Special snowflake (Winblows) socket support
- [ ] SOCKS4a/SOCKS5 proxy implementation
- [ ] HTTP proxy implementation
- v1.1:
- [ ] File transfer
- [ ] Memos (with TTL)
API Documentation API Documentation
----------------- -----------------
NeoComm uses [Doxygen](http://www.stack.nl/~dimitri/doxygen/) to generate its documentation (for NeoComm developers please refer to the [contributing section](#contributing)) which generates HTML and `man` page documentation which you can do so by running `doxygen` in the root directory of the project or by using their graphical wizard. NeoComm uses [Doxygen](http://www.stack.nl/~dimitri/doxygen/) to generate its documentation (for NeoComm developers please refer to the [contributing section](#contributing)) which generates HTML and `man` page documentation which you can do so by running `doxygen` in the root directory of the project or by using their graphical wizard.