Skip to content

Commit 7d273b0

Browse files
committed
feat: prepare for publish
1 parent e777354 commit 7d273b0

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

Cargo.toml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
[package]
22
name = "harmony_rust_sdk"
33
version = "0.1.0"
4-
authors = ["Yusuf Bera Ertan <[email protected]>"]
4+
authors = [ "Yusuf Bera Ertan <[email protected]>" ]
55
edition = "2018"
66
license = "MIT"
7+
description = "Rust library to work with the Harmony chat protocol."
8+
repository = "https://github.com/yusdacra/harmony_rust_sdk"
9+
homepage = "https://github.com/yusdacra/harmony_rust_sdk"
10+
keywords = [ "harmony", "protocol", "api", "client" ]
11+
categories = [ "api-bindings" ]
12+
exclude = [
13+
"*.nix",
14+
"flake.lock",
15+
".github/*",
16+
]
717

818
[dependencies]
919
prost = "0.6"

src/client/api/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ pub mod profile;
44

55
type Unit = ();
66

7+
/// This is NOT a part of the public API and should NOT be used.
78
#[macro_export]
9+
#[doc(hidden)]
810
macro_rules! client_api {
911
{
1012
api_func: $fn_name:ident,
@@ -42,7 +44,9 @@ macro_rules! client_api {
4244
};
4345
}
4446

47+
/// This is NOT a part of the public API and should NOT be used.
4548
#[macro_export]
49+
#[doc(hidden)]
4650
macro_rules! client_api_action {
4751
{
4852
api_func: $fn_name:ident,

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
//! Rust library to work with the Harmony chat protocol.
2+
//!
3+
//! This crate currently contains the generated API code and client API with a lightweight client implementation.
4+
15
/// Harmony protocol code generated with [`tonic-build`](https://lib.rs/crates/tonic-build).
26
pub mod api {
37
pub mod core {

0 commit comments

Comments
 (0)