Skip to content

Commit d5ca085

Browse files
committed
Update README.md
1 parent 23e611c commit d5ca085

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ piles of bytes', but instead you say 'I want to listen for fancy::MyClass'.
1616

1717
### How do I use Breep::network ?
1818

19-
The best way to now it is to read this examples. But as a little preview, here is a small one
19+
The best way to now it is to read its [examples](examples/) or to [read the online doc](https://organic-code.github.io/Breep/). But as a little preview, here is a small one
2020

2121
Here is how to create a network, start listening on port 1234, and send "Hello!" to any budy that connects:
2222
```cpp
@@ -66,12 +66,30 @@ Please don't get confused: there is no UDP in this lib (yet).
6666
* The overhead for this is low: if you set up well your serialization, you only have a fixed 64bits extra overhead
6767
* It's easy to get in: just read the examples, you'll see!
6868

69-
### Why should I NOT Breep::network ?
69+
### Why should I NOT use Breep::network ?
7070

7171
* It has not been tested as much as it should have been.
7272
* It's probably broken for BigEndian architecture (I have no way to test this, sorry ; a warning should be displayed on such architectures.)
7373
* It's very, *very* slow to compile with.
7474

75+
## Requirements
76+
77+
| Resource | Requirement |
78+
|:------------------------------:|:-------------------------:|
79+
| Compiler | C++14 compliant or above |
80+
| [Boost](http://www.boost.org/) | Boost 1.55 or above |
81+
82+
83+
## Road Map
84+
85+
| Milestone | Feature | Status |
86+
|:--------------------------------------------------------:|:-----------------------------------:|:-----------:|
87+
| 0.1 | Peer to peer network management | complete |
88+
| 0.1 | Instantiated objects delivery | complete |
89+
| [1.0](https://github.com/Organic-Code/Breep/milestone/1) | Improved serialization | development |
90+
| [1.0](https://github.com/Organic-Code/Breep/milestone/1) | Multiple objects delivery in one go | pending |
91+
| [x.x](https://github.com/Organic-Code/Breep/issues/1) | Client server network management | on hold |
92+
7593
## License
7694

7795
This work is under the [European Union Public License v1.1](LICENSE.md).

0 commit comments

Comments
 (0)