Merge pull request #104 from CosmWasm/documentation-updates

Updates to README

Cargo.toml

@@ -3,7 +3,7 @@ name = "cw-multi-test"
 version = "0.18.1"
 authors = ["Ethan Frey <ethanfrey@users.noreply.github.com>"]
 edition = "2021"
-description = "Test helpers for multi-contract interactions"
+description = "Testing tools for multi-contract interactions"
 license = "Apache-2.0"
 repository = "https://github.com/CosmWasm/cw-multi-test"
 homepage = "https://cosmwasm.com"

NOTICE

@@ -0,0 +1,15 @@
+cw-multi-test: Testing tools for multi-contract interactions
+
+Copyright (C) 2021-2023 Confio GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,38 +1,61 @@
-## CosmWasm MultiTest README 
+# CosmWasm MultiTest 
 
-## Introduction 
+[![cw-multi-test on crates.io][crates-badge]][crates-url]
+[![docs][docs-badge]][docs-url]
+[![codecov][codecov-badge]][codecov-url]
+[![license][apache-badge]][apache-url]
+
+[crates-badge]: https://img.shields.io/crates/v/cw-multi-test.svg
+[crates-url]: https://crates.io/crates/cw-multi-test
+[docs-badge]: https://docs.rs/cw-multi-test/badge.svg
+[docs-url]: https://docs.rs/cw-multi-test
+[codecov-badge]: https://codecov.io/gh/CosmWasm/cw-multi-test/branch/main/graph/badge.svg?token=IYY72ZVS3X
+[codecov-url]: https://codecov.io/gh/CosmWasm/cw-multi-test
+[apache-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+[apache-url]: LICENSE
+[notice-url]: NOTICE
 
-CosmWasm `MultiTest` is a dynamic suite of testing tools designed for facilitating multi-contract 
-interactions within the CosmWasm ecosystem. Its primary focus is on providing developers
-with a robust framework for simulating complex contract interactions and bank operations. 
-Currently in the alpha stage, CosmWasm MultiTest is primarily used internally for testing cw-plus contracts. 
+> **Testing tools for multi-contract interactions**
+
+## Introduction 
 
-## Warning and Current Status 
-## Alpha Stage Caution 
+**CosmWasm MultiTest** is a suite of testing tools designed for facilitating multi-contract 
+interactions within the [CosmWasm](https://github.com/CosmWasm) ecosystem.
+Its primary focus is on providing developers with a robust framework for simulating
+complex contract interactions and bank operations. Currently, **CosmWasm MultiTest**
+is in the _alpha_ stage, and primarily used internally for testing
+[cw-plus](https://github.com/CosmWasm/cw-plus) contracts. 
 
-CosmWasm MultiTest is currently in its alpha development phase, primarily intended for internal use.
-Developers are advised to use this framework cautiously, understanding that it is still undergoing 
-significant development and refinement. The current version lacks API stability,
-which is a crucial aspect to consider for projects that require long-term consistency and dependability. 
+## Current Status 
 
-## Internal Use and Refinement 
+### Internal Use and Refinement 
 
-Internally, the CosmWasm MultiTest framework is an essential tool for the testing of cw-plus contracts.
-Its development is focused on ensuring the reliability and security of these contracts.
-The team is actively working on refactoring and enhancing CosmWasm MultiTest to provide a 
-more stable and feature-rich version for broader community use in the future. 
+Internally, the **CosmWasm MultiTest** framework is an essential tool for the
+testing of cw-plus contracts. Its development is focused on ensuring the reliability 
+and security of these contracts. The team is actively working on refactoring and enhancing
+**CosmWasm MultiTest** to provide a more stable and feature-rich version for broader
+community use in the future. 
 
-## Framework Capabilities 
+### Framework Capabilities 
 
-CosmWasm `MultiTest` enables comprehensive unit testing, including scenarios where contracts
+**CosmWasm MultiTest** enables comprehensive unit testing, including scenarios where contracts
 call other contracts and interact with the bank module. Its current implementation 
 effectively handles these interactions, providing a realistic testing environment for contract developers.
-The team is committed to extending CosmWasm MultiTest's capabilities, making it a versatile tool 
-for various blockchain interaction tests. 
+The team is committed to extending **CosmWasm MultiTest**'s capabilities, making it a versatile tool 
+for various blockchain interaction tests.
 
 ## Conclusion 
 
-CosmWasm MultiTest stands as a vital development tool in the CosmWasm ecosystem, especially for 
-developers engaged in building complex decentralized applications. As the framework evolves, it is
-poised to become an even more integral part of the CosmWasm development toolkit. Users are encouraged 
-to stay updated with its progress and contribute to its development. 
+**CosmWasm MultiTest** stands as a vital development tool in
+the [CosmWasm](https://github.com/CosmWasm) ecosystem, especially for developers engaged
+in building complex decentralized applications. As the framework evolves, it is poised to become
+an even more integral part of the [CosmWasm](https://github.com/CosmWasm) development toolkit.
+Users are encouraged to stay updated with its progress and contribute to its development. 
+
+## License
+
+Licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+(see [LICENSE][apache-url] and [NOTICE][notice-url]).
+
+Any contribution intentionally submitted for inclusion in this crate by you,
+shall be licensed as above, without any additional terms or conditions.