You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-5Lines changed: 25 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,16 @@ LibSourcey is a collection of cross platform C++14 modules and classes that prov
24
24
25
25
***Clean and readable code** — Modern C++ design principles have been adhered to throughout for clean and readable code.
26
26
27
-
***Networking layer** — A solid network layer is absolutely essential. The networking layer contains TCP, SSL and UDP socket implementations that combine `libuv` under the hood for blazing fast networking, and `openssl` for security and encryption.
27
+
***Easy packaging and installation** — LibSourcey can be compiled and installed on most platforms with `CMake`. For straight forward distribution and integration with existing projects the libraries be also packaged as a `deb`, `rpm`, `tar.gz`, `zip`, and more formats with a [single command](https://sourcey.com/libsourcey/installation#building-packages).
28
28
29
-
***Media streaming and encoding** — The `av` library consists of thin wrappers around `FFmpeg` and `OpenCV` for media capture, encoding, recording, streaming, analysis and more.
29
+
***Docker images** — Semantically versioned images are available on [Docker Hub](https://hub.docker.com/r/sourcey/libsourcey/). Just type `docker pull sourcey/libsourcey` to grab the latest.
30
30
31
-
***Easy install** — LibSourcey can be packaged as a `deb`, `rpm`, `tar.gz`, `zip` and many other formats with a [single command](https://sourcey.com/libsourcey/installation#building-packages) for straight forward distribution and integration.
31
+
***Solid networking layer** — At the core of LibSourcey is a solid and blazing fast networking layer build on `libuv` and `openssl` primitives, with TCP, SSL and UDP socket implementations.
32
32
33
33
***Web servers and clients** — A HTTP stack is provided that includes servers, clients, WebSockets, media streaming, file transfers, and authentication. The HTTP parser is based on the super-fast C code used by `nginx`.
34
34
35
+
***Media streaming and encoding** — The `av` library consists of thin wrappers around `FFmpeg` and `OpenCV` for media capture, encoding, recording, streaming, analysis and more.
36
+
35
37
***Realtime messaging** — LibSourcey aims to bridge the gap between desktop, mobile and web by providing performance oriented messaging solutions that work across all platforms.
36
38
***Socket.IO** — Socket.IO C++ client that supports the latest protocol revision 4 (>= 1.0). Read more about [Socket.IO](http://socket.io).
37
39
***Symple** — Sourcey's home grown realtime messaging protocol that works over the top of Socket.IO to provide rostering, presence and many other features necessary for building online games and chat applications. [More about Symple](https://sourcey.com/symple).
@@ -44,12 +46,30 @@ LibSourcey is a collection of cross platform C++14 modules and classes that prov
44
46
* **STUN** — [RFC 5389](http://tools.ietf.org/rfc/rfc5389) implementation that includes support for ICE and TURN and TURN TCP messages.
45
47
* **TURN** — Server and client stack that supports both [RFC 5766 (Traversal Using Relays around NAT)](http://tools.ietf.org/rfc/rfc5766) and [RFC 6062 (Traversal Using Relays around NAT Extensions for TCP Allocations)](http://tools.ietf.org/rfc/rfc6062) specifications.s
46
48
* **SDP** — [RFC 4566](http://tools.ietf.org/rfc/rfc4566) implementation that includes extra support for ICE headers.
47
-
-->
49
+
-->
48
50
49
51
## Getting started
50
52
51
53
See the [installation guides](https://sourcey.com/libsourcey/installation) in the docs to get started playing with LibSourcey.
52
54
55
+
56
+
<!--
57
+
TODO: move to docs
58
+
### Using Docker
59
+
60
+
Building with Docker:
61
+
62
+
```
63
+
sudo docker build .
64
+
```
65
+
66
+
Docker images are available on Docker Hub: https://hub.docker.com/r/sourcey/libsourcey/
67
+
68
+
```
69
+
sudo docker pull sourcey/libsourcey
70
+
```
71
+
-->
72
+
53
73
## A few examples
54
74
55
75
What better way to get acquainted with a new library then with some tasty code examples.
@@ -122,7 +142,7 @@ proc.spawn();
122
142
proc.in() << "random data"
123
143
~~~
124
144
125
-
#### PacketStream
145
+
#### Packet Stream
126
146
127
147
A good starting point for learning LibSourcey is the `PacketStream`, which lets you create a dynamic delegate chain for piping, processing and outputting arbitrary data packets. This method of layering packet processors and makes it possible to develop complex data processing applications on the fly.
0 commit comments