From 38913d046a6bac123a5e4a0adc450eb719f4c6e2 Mon Sep 17 00:00:00 2001
From: Patrick <patrick.schoenberger@posteo.de>
Date: Mon, 13 Nov 2023 22:47:09 +0100
Subject: [PATCH 1/1] Readme

---
 Readme.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/Readme.md b/Readme.md
index 606f53d..614808e 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1 +1,63 @@
 # Matrix Client Library in C
+
+This is a library implementing parts of the [Matrix](https://matrix.org/) [Client-Server API](https://spec.matrix.org/v1.8/client-server-api/).
+It is written in C and supports sending and receiving of messages, including end-to-end encryption.
+Device verification is also supported.
+
+## Building
+
+Building requires a C/C++ compiler and make.
+To build the dependencies run `make deps`.
+To build any of the examples run `make out/examples/<example>`.
+To use the library:
+- Add `src/matrix.c` to compilation
+- Add either `src/matrix_http_mongoose.c` or `src/matrix_http_esp32.c` to compilation
+- Add `out/*.o` to compilation
+- Add include path `src/`
+- Add include path `ext/olm/include/`
+- Add include path `ext/mjson/src/`
+- Add include path `ext/mongoose/`
+
+## Dependencies
+[Mongoose](https://github.com/cesanta/mongoose)
+[mjson](https://github.com/cesanta/mjson)
+[Olm](https://gitlab.matrix.org/matrix-org/olm)
+
+## Examples
+
+### Sending an encrypted message
+```
+MatrixMegolmOutSession * megolmOutSession;
+MatrixClientNewMegolmOutSession(&client,
+    ROOM_ID,
+    &megolmOutSession);
+printf("megolm session id: %.10s... key: %.10s...\n", megolmOutSession->id, megolmOutSession->key);
+
+MatrixClientShareMegolmOutSession(&client,
+    USER_ID,
+    "ULZZOKJBYN",
+    megolmOutSession);
+
+MatrixClientSendEventEncrypted(&client,
+    ROOM_ID,
+    "m.room.message",
+    "{\"body\":\"Hello\",\"msgtype\":\"m.text\"}");
+```
+
+### Verification
+```
+// Request an encrypted event to enable verification
+STATIC char eventBuffer[1024];
+MatrixClientGetRoomEvent(client,
+    ROOM_ID,
+    EVENT_ID,
+    eventBuffer, 1024);
+
+#define SYNC_BUFFER_SIZE 1024*10
+STATIC char syncBuffer[SYNC_BUFFER_SIZE];
+STATIC char nextBatch[1024];
+
+while (! client->verified) {
+    MatrixClientSync(client, syncBuffer, SYNC_BUFFER_SIZE, nextBatch, 1024);
+}
+```
\ No newline at end of file
-- 
2.50.1