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: websocket/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@ This is a WebSocket implementation in Rust that utilizes the standard library. I
5
5
- Publish a library in crates.io.
6
6
- How to use the library from other languages.
7
7
8
-
The project is currently in beta phase, and while it is functional, further work is needed for the final version. Since I am a sole developer and cannot dedicate as much time as I would like, I have decided to publish it for those who want to try it out and contribute to the project [CONTRIBUTING.md](./CONTRIBUTING.md).
8
+
The project is currently in beta phase, and while it is functional, further work is needed for the final version. Since I am a sole developer and cannot dedicate as much time as I would like, I have decided to publish it for those who want to try it out and contribute to the project [CONTRIBUTING.md](../CONTRIBUTING.md).
9
9
10
10
You can use the library in the following ways:
11
11
12
12
- In any Rust project that allows the use of the standard library, such as ``esp-rs`` with ``std`` support. Check out the [esp-rs docs](https://esp-rs.github.io/book/overview/using-the-standard-library.html) for more information.
13
-
- In any C project, as it has a compatible FFI (Foreign Function Interface). You’ll need to compile the project as a static library and link it appropriately. Refer to this guide ([static lib usage](./ffi/README.md)) for more details.
13
+
- In any C project, as it has a compatible FFI (Foreign Function Interface). You’ll need to compile the project as a static library and link it appropriately. Refer to this guide ([static lib usage](../ffi/README.md)) for more details.
14
14
15
15
**Feel free to explore the project and contribute! 🚀**
16
16
@@ -19,11 +19,11 @@ You can use the library in the following ways:
19
19
## Static library
20
20
In the ``ffi/`` folder you will find the ``websocket-std.h`` header and a compiled static library for the xtensa architecture of the esp32 microcontroller from espressif.
21
21
22
-
You can use this static library in your esp idf and arduino projects for esp32. Check [ffi/xtensa-esp32-idf](./ffi/xtensa-esp32-espidf/README.md) for more information.
22
+
You can use this static library in your esp idf and arduino projects for esp32. Check [ffi/xtensa-esp32-idf](../ffi/xtensa-esp32-espidf/README.md) for more information.
23
23
24
24
## Examples
25
25
26
-
The [examples](./examples/) folder contains various examples of how to use ``websocket-std``.
26
+
The [examples](../examples/) folder contains various examples of how to use ``websocket-std``.
27
27
28
28
## Features
29
29
@@ -33,7 +33,7 @@ The sync client manage an internal event loop, when you call a function to perfo
33
33
it will be queued and as soon as you call the ``event_loop`` function it will perform one input (something was received)
34
34
and one output (something to send to server) operations in one execution.
35
35
36
-
You can also use ``threads`` to work with the library. Check [examples](./examples/) for more information.
36
+
You can also use ``threads`` to work with the library. Check [examples](../examples/) for more information.
0 commit comments