Skip to content

Commit

Permalink
docs: add reference to the new testing framework
Browse files Browse the repository at this point in the history
Signed-off-by: Vincenzo Palazzo <[email protected]>
  • Loading branch information
vincenzopalazzo committed Sep 9, 2023
1 parent 8b618ce commit a2325c6
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ These are the complete list of craters supported right now
| clightningrpc-plugin | Crate that provides a plugin API to give the possibility to implement a plugin in Rust | ![Crates.io](https://img.shields.io/crates/v/clightningrpc-plugin?style=flat-square) |
| clightningrpc-plugin-macros | Crate that provides a procedural macros implementation to make easy to develop a plugin developer to build a plugin | ![Crates.io](https://img.shields.io/crates/v/clightningrpc-plugin_macros?style=flat-square) |
| clightningrpc-conf | This crate provides configuration manager for core lightning. | ![Crates.io](https://img.shields.io/crates/v/clightningrpc-conf?style=flat-square) |
| clightningrpc-testing | This crate provides test framework for core lightning (including bitcoin). | unrelated |

## Contributing guidelines

Expand Down
39 changes: 39 additions & 0 deletions testing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<div align="center">
<h1>Core Lightning rust test framework</h1>

<p>
<strong>Crate that provides a test framework for core lightning.</strong>
</p>

<p>
</p>

<h4>
<a href="https://github.com/laanwj/rust-clightning-rpc">Project Homepage</a>
</h4>

<a href="https://docs.rs/clightning-testing">
<img alt="docs.rs" src="https://img.shields.io/docsrs/clightning-testing?style=flat-square"/>
</a>

</div>

Crate that provides a testing framework for core lightning (including bitcoin).

```rust
// TODO
```

# Contributing guidelines

- Four spaces
- Call `make fmt` before committing
- If you can, GPG-sign at least your top commit when filing a PR

# Supports

If you want support this library consider to donate with the following methods

- Lightning address: [email protected]
- BOLT 12: https://bruce.lnmetrics.info/donation
- [Github donation](https://github.com/sponsors/vincenzopalazzo)

0 comments on commit a2325c6

Please sign in to comment.