Skip to content

Commit 55f87d4

Browse files
authored
docs: fix mardown syntax (#43)
error reported by markdownlint
1 parent 244bdf2 commit 55f87d4

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ expert, we can use your help.
1212
This guide will help you get started. **Do not let this guide intimidate you**.
1313
It should be considered a map to help you navigate the process.
1414

15-
1615
## Asking for General Help
1716

1817
If you have reviewed existing documentation and still have questions or are
@@ -41,7 +40,5 @@ Note that multiple commits often get squashed when they are landed.
4140

4241
Commit messages should follow [Conventional commits].
4342

44-
4543
[just]: https://just.systems/
4644
[Conventional commits]: https://www.conventionalcommits.org/
47-
[crate.io]: https://crates.io/

rustainers/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
# rustainers
2+
13
[![Build status](https://github.com/wefoxplatform/rustainers/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/wefoxplatform/rustainers/actions/workflows/ci.yml)
24
[![Crates.io](https://img.shields.io/crates/v/rustainers)](https://crates.io/crates/rustainers)
35
[![Documentation](https://docs.rs/rustainers/badge.svg)](https://docs.rs/rustainers)
46

5-
# rustainers
6-
77
`rustainers` is a simple, opinionated way to run containers for tests.
88

99
## TL;DR
@@ -22,7 +22,7 @@ The key differences are
2222
- this crate supports [docker compose], [podman-compose] or [nerdctl compose]
2323
- the start command is `async`, and the crate is using [tokio]
2424

25-
For now, the implementation is based on the CLI command.
25+
For now, the implementation is based on the CLI command.
2626
We may add more runner based on Rust api later.
2727

2828
## Run a simple container
@@ -115,7 +115,6 @@ async fn do_something_with_kafka(image: &KafkaSchemaRegistry) -> anyhow::Result<
115115

116116
See [`images`](crate::images) module documentation.
117117

118-
119118
## Create a custom compose images
120119

121120
See [`compose::images`](crate::compose::images) module documentation.

0 commit comments

Comments
 (0)