Skip to content

Commit

Permalink
docs: change README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DDtKey committed Sep 27, 2023
1 parent 1050e53 commit f830d0e
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,18 @@ Testcontainers-rs is the official Rust language fork of [http://testcontainers.o

## Usage

### `testcontainers` is the core crate
The crate provides an API for working with containers in a test environment.

1. Depend on `testcontainers`
2. Import `use testcontainers::*`.
2. Implement `testcontainers::core::Image` for necessary docker-images
3. Run it with any available client `testcontainers::clients::*`

### Ready-to-use images

Check [the integration tests](./testcontainers/tests) on how to use the library.
The easiest way to use `testcontainers` is to depend on ready-to-use images (aka modules).

A set of ready-to-use images (aka modules) is available as a community-maintained crate: [testcontainers-modules](https://github.com/testcontainers/testcontainers-rs-modules-community)
Modules are available as a community-maintained crate: [testcontainers-modules](https://github.com/testcontainers/testcontainers-rs-modules-community)

## License

Expand Down

0 comments on commit f830d0e

Please sign in to comment.