update readme

This commit is contained in:
yggverse 2024-10-25 19:31:59 +03:00
parent 6819de5276
commit 1f25565a79

View file

@ -21,7 +21,7 @@ cargo add ggemini
High-level API to make async socket request and auto-close connection on complete. High-level API to make async socket request and auto-close connection on complete.
Return [Response](#clientresponseresponse) on success or [Error](#clienterror) enum on failure. Return [Response](#clientresponseresponse) on success or [Error](#clienterror) enum on failure
``` rust ``` rust
use glib::{Uri, UriFlags}; use glib::{Uri, UriFlags};
@ -44,7 +44,7 @@ match Uri::parse("gemini://geminiprotocol.net/", UriFlags::NONE) {
} }
``` ```
Pay attention: **Pay attention:**
* Response [Buffer](#clientsocketconnectioninputbufferBuffer) limited to default `capacity` (0x400) and `max_size` (0xfffff). If you want to change these values, use low-level API to setup connection manually. * Response [Buffer](#clientsocketconnectioninputbufferBuffer) limited to default `capacity` (0x400) and `max_size` (0xfffff). If you want to change these values, use low-level API to setup connection manually.
* To use [Cancelable](https://docs.gtk.org/gio/class.Cancellable.html) or async Priority values, take a look at [connection](#clientsocketconnection) methods. * To use [Cancelable](https://docs.gtk.org/gio/class.Cancellable.html) or async Priority values, take a look at [connection](#clientsocketconnection) methods.