chore: Preparation for publishing SDK

[poppoerika]

• Added more documentation
• Added clippy
• Added README.md
• Updated Cargo.toml
• Fixed any issues came up with clippy run

Ticket: #20

[kvcache]

This is a little confusing to me. Can you explain what's happening here?

[poppoerika]

I think I need to update that actually, but that structure is suggested by clippy.
It gave me this error: error: passing a unit value to a function
So I think what I want to do here:

let mut result = {
            let message = request.into_inner();
            tonic::Request::new(message)
};

Reference: https://rust-lang.github.io/rust-clippy/master/index.html#unit_arg

[kvcache]

if request.into_inner() returns unit then why are we calling it? Or does it not return unit and this was actually a bug?

[poppoerika]

Hmm it does not look like request.into_inner() is returning unit?
Clippy might have given us false positive? rust-lang/rust-clippy#1502
https://docs.rs/tonic/latest/tonic/struct.Request.html#method.into_inner

    /// Consumes `self`, returning the message
    pub fn into_inner(self) -> T {
        self.message
    }

[kvcache]

into_inner() returns T, as your snippet shows. request is tonic::Request<()>. T is (). So why are we calling .into_inner() on request?

[kvcache]

Are these generated or did you add them?

If you added them, do /// formatted comments show up in typical ides like IntelliJ and VS Code?

[poppoerika]

I added them and these are for rust documentation that will appear in our package's doc website when we publish it to crates.io.
https://doc.rust-lang.org/rust-by-example/meta/doc.html
For example, mio has this doc website and anything in /// appear in that doc.
Source code: https://docs.rs/mio/0.8.2/src/mio/interest.rs.html#4-15
Mio's doc website:

[kvcache]

Cool. I prefer /// docs anyway, thanks for confirming this is by design.

[kvcache]

Feels good cleaning all this stuff up huh?

[poppoerika]

YUP! Thank you Clippy.