From 0c84b9996bd7810bb7e980500f4c9b47287e7688 Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Sat, 18 Nov 2023 12:26:38 +0100 Subject: [PATCH] Mention use of git dependencies in README --- lib/grammers-client/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/grammers-client/README.md b/lib/grammers-client/README.md index 5f7123ea..3bbee003 100644 --- a/lib/grammers-client/README.md +++ b/lib/grammers-client/README.md @@ -5,3 +5,12 @@ This library is a higher-level interface to interact with Telegram's API. It contains the code necessary to create a client, connect to the API and make Remote Procedure Calls (RPC) to it, such as signing in or sending a message. + +The library is in development, but new releases are only cut rarely. +[Specifying the dependency from the git repository][dep-git] is recommended: + +```toml +grammers-client = { git = "https://github.com/Lonami/grammers" } +``` + +[dep-git]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories