1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-23 00:00:06 +01:00
libwebsockets/README.md

49 lines
2.9 KiB
Markdown
Raw Normal View History

[![CI status](https://libwebsockets.org/sai/status/libwebsockets)](https://libwebsockets.org/git/libwebsockets) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3576/badge.svg)](https://scan.coverity.com/projects/3576) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2266/badge)](https://bestpractices.coreinfrastructure.org/projects/2266) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/144fb195a83046e484a75c8b4c6cfc99)](https://www.codacy.com/app/lws-team/libwebsockets?utm_source=github.com&utm_medium=referral&utm_content=warmcat/libwebsockets&utm_campaign=Badge_Grade) [![Total alerts](https://img.shields.io/lgtm/alerts/g/warmcat/libwebsockets.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/warmcat/libwebsockets/alerts/) [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/warmcat/libwebsockets.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/warmcat/libwebsockets/context:cpp) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/warmcat/libwebsockets.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/warmcat/libwebsockets/context:javascript)
# Libwebsockets
Libwebsockets is a simple-to-use, MIT-license, pure C library providing client and server
2020-03-04 10:01:28 +00:00
for **http/1**, **http/2**, **websockets**, **MQTT** and other protocols in a security-minded,
lightweight, configurable, scalable and flexible way. It's easy to build and
cross-build via cmake and is suitable for tasks from embedded RTOS through mass
cloud serving.
2021-08-02 07:23:52 +01:00
It supports a lot of lightweight ancilliary implementations for things like JSON,
CBOR, JOSE, COSE, and supports OpenSSL and MbedTLS v2 and v3 out of the box for everything.
It's very gregarious when it comes to event loop sharing, supporting libuv, libevent, libev,
sdevent, glib and uloop, as well as custom event libs.
2021-08-02 07:23:52 +01:00
[100+ independent minimal examples](https://libwebsockets.org/git/libwebsockets/tree/minimal-examples) for various scenarios, CC0-licensed
(public domain) for cut-and-paste, allow you to get started quickly.
2021-04-15 17:43:39 +01:00
2021-08-02 07:23:52 +01:00
[There are a lot of READMEs](https://libwebsockets.org/git/libwebsockets/tree/READMEs) on a variety of topics.
[We do a huge amount of CI testing per push](https://libwebsockets.org/sai/), currently 510 builds on 27 platforms.
2021-04-15 17:43:39 +01:00
2018-12-13 20:05:12 +08:00
![overview](./doc-assets/lws-overview.png)
2017-03-16 10:46:31 +08:00
News
----
2021-04-15 17:43:39 +01:00
## v4.2 is released
2021-04-15 17:43:39 +01:00
See the [changelog](https://libwebsockets.org/git/libwebsockets/tree/changelog)
## Support
2016-08-07 08:33:08 +08:00
This is the libwebsockets C library for lightweight websocket clients and
servers. For support, visit
https://libwebsockets.org
and consider joining the project mailing list at
https://libwebsockets.org/mailman/listinfo/libwebsockets
You can get the latest version of the library from git:
- https://libwebsockets.org/git
2021-07-12 09:36:35 +01:00
Doxygen API docs for development: https://libwebsockets.org/lws-api-doc-main/html/index.html