Update README files of each crate to show usage with `cargo add`

[metaclips]

All crates in this folder have readme files https://github.com/build-trust/ockam/tree/2ea26c64036e61669181f17c92b0906a6a434a79/implementations/rust/ockam

We currently have this format as usage instruction in each README.md file https://github.com/build-trust/ockam/blob/2ea26c64036e61669181f17c92b0906a6a434a79/implementations/rust/ockam/ockam/README.md?plain=1#L65-L72

We want to update this Usage section to use the new cargo add command.

We also have readme files that are missing usage instructions so we have to add those as well, similar to other crates.

• [ ] Ockam Transport BLE crate
• [ ] Ockam MultiAddr crate
• [ ] Ockam Command crate (we need to instead use the cargo install ockam_command@version command here)
• [ ] Ockam API crate

[lameferret]

Hey, I was looking into other major rust projects like tokio, most of them use current format:

[dependencies] 
"crate-name" = "major version" 
"crate-name" = "*"

This format also allows better representation of features used (if any), and rust book also uses it.

[mrinalwadhwa]

@anuvratsingh Interesting point about features. @metaclips Maybe we should stay with the old format for now. Just add the places where the instructions are missing.

At the top level when introducing new people, in examples/guides etc, we can start with cargo add.

[lameferret]

For examples: cargo run --example <example-name> doesn't help, it just shows how to run the example. Better approach would be: Tokio example.

[metaclips]

Hey, I was looking into other major rust projects like tokio, most of them use current format:

[dependencies] 
"crate-name" = "major version" 
"crate-name" = "*"

This format also allows better representation of features used (if any), and rust book also uses it.

Thanks @anuvratsingh . Cargo add also has the feature options. I'm in support to stay with the old format till cargo add is widely known. As @mrinalwadhwa stated, we should ensure all crates readme include in them, usage instructions.

[mariannegoldin]

Hi there, I am working with some new contributors to open source (and ockam) and wondering if you would be open to us working on this issue?

[mrinalwadhwa]

@mariannegoldin that would be great 👍

[metaclips]

~I don't think this is needed as we now use cargo-readme to generate readme files cc @etorreborre @mrinalwadhwa~

[metaclips]

I updated the issue to use cargo-readme instead to update readme files

[metaclips]

Closing now. Thanks everyone