diff --git a/README.md b/README.md index 8f18485..23ce77b 100644 --- a/README.md +++ b/README.md @@ -20,30 +20,28 @@ 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. +What follows is a list roadmap of features and the (approximate) versions in which they will be implemented. The API will only change in major versions of the library, while minor versions will be dedicated to internal improvements and patch versions to small fixes that got past the release. - - v0.1-alpha: + - v1.0-alpha: - [ ] Node connectivity - [ ] Messages properly sent and received - - v0.1: + - v1.0-beta: - [ ] Channel functionality - [ ] Message encryption - - [ ] Sample nodes for testing - - v0.2: - [ ] Private messages - v1.0: - [ ] Special snowflake (Winblows) socket support - [ ] SOCKS4a/SOCKS5 proxy support - [ ] HTTP proxy support - - v1.1: - - [ ] File transfer + - v2.0: + - [ ] P2P File transfer - [ ] Memos (with TTL) 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. -Public documentation will be published with every release. +Public documentation will be published with every major release. Clients -------