Docs: Update README for library

[tvpeter]

Description

This PR updates the Readme for the library. It also adds project License files.

Checklists

All Submissions:

• I've signed all my commits
• I followed the contribution guidelines
• I ran cargo fmt and cargo clippy before committing

[oleonardolima]

cACK

[ValuedMammal]

This looks great.

In 699fafc - docs: Update README for the library

For code blocks you should include the language to enable syntax highlighting. Note that for toml files comments are denoted with #.

[luisschwab]

There's no Apache-2.0 License in this PR or the repo.

[luisschwab]

Should have a LICENSE-MIT, LICENSE-APACHE and a LICENSE.md (so GH renders it).

[ValuedMammal]

ACK 1da987e fixed sentence spacing and missing backtick in docs.

--- a/src/client.rs
+++ b/src/client.rs
@@ -107,11 +107,11 @@ impl Client {
         Self {
             inner: jsonrpc::Client::with_transport(transport),
         }
     }
 
-    /// Calls the underlying RPC `method` with the given`args`.
+    /// Calls the underlying RPC `method` with the given `args`.
     ///
     /// This is the generic function used by all specific RPC methods.
     pub fn call<T>(&self, method: &str, args: &[serde_json::Value]) -> Result<T, Error>
     where
         T: for<'de> serde::Deserialize<'de>,
@@ -160,11 +160,11 @@ impl Client {
             .0
             .try_into()
             .map_err(Error::TryFromInt)
     }
 
-    /// Retrieves the ['BlockHash'] of the block at `height`.
+    /// Retrieves the [`BlockHash`] of the block at `height`.
     ///
     /// # Arguments
     ///
     /// * `height`: The block height
     ///

[ValuedMammal]

reACK 1d89d3c

[luisschwab]

@ValuedMammal we don't have the actual LICENSE-APACHE, LICENSE-MIT and LICENSE.md files here yet.

[luisschwab]

@ValuedMammal we don't have the actual LICENSE-APACHE, LICENSE-MIT and LICENSE.md files here yet.

I meant that these should be added in this PR.

[luisschwab]

@tvpeter can you rename LICENSE to LICENSE.md? Otherwise GitHub won't render the Markdown links.

[luisschwab]

Suggested change

	Except as otherwise noted in individual files, all files in this repository are
	licensed under the Apache License, Version 2.0 <[Apache 2.0](LICENSE-APACHE) or
	http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <[MIT](LICENSE-MIT) or
	http://opensource.org/licenses/MIT>, at your option.
	Except as otherwise noted in individual files, all files in this repository are
	licensed under the Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
	<http://www.apache.org/licenses/LICENSE-2.0>) or the MIT License ([LICENSE-MIT](LICENSE-MIT) or
	<http://opensource.org/licenses/MIT>), at your option.

[tvpeter]

Should the link title (LICENSE-APACHE, LICENSE-MIT) be uniform everywhere? In Readme and at the top of LICENSE.md?

[luisschwab]

@tvpeter your latest push is not quite right. Compare it against my last review.

[tvpeter]

@tvpeter your latest push is not quite right. Compare it against my last review.

Seen it and fixed. Thank you.

[luisschwab]

ACK 8bf074a

[ValuedMammal]

ACK