#7 - Doc fixes
This commit is contained in:
parent
7f270a9680
commit
736d06563c
1 changed files with 19 additions and 2 deletions
21
README.md
21
README.md
|
|
@ -58,10 +58,12 @@ Creates a testcontainers instance and returns them
|
||||||
:exposed-ports [80]
|
:exposed-ports [80]
|
||||||
:env-vars {"MAGIC_NUMBER" "42"
|
:env-vars {"MAGIC_NUMBER" "42"
|
||||||
:command ["/bin/sh"
|
:command ["/bin/sh"
|
||||||
"-c"
|
"-c"
|
||||||
"while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]})
|
"while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### start!
|
### start!
|
||||||
Starts the Testcontainer, which was defined by `create`
|
Starts the Testcontainer, which was defined by `create`
|
||||||
|
|
||||||
|
|
@ -92,6 +94,9 @@ Starts the Testcontainer, which was defined by `create`
|
||||||
(start! container)
|
(start! container)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
### stop!
|
### stop!
|
||||||
Stops the Testcontainer, which was defined by `create`
|
Stops the Testcontainer, which was defined by `create`
|
||||||
|
|
||||||
|
|
@ -116,6 +121,9 @@ The `container-config`
|
||||||
(stop! container)
|
(stop! container)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
### map-classpath-resource!
|
### map-classpath-resource!
|
||||||
Maps a resource from your classpath into the containers file system
|
Maps a resource from your classpath into the containers file system
|
||||||
|
|
||||||
|
|
@ -142,6 +150,9 @@ The `container-config`
|
||||||
:mode :read-only})
|
:mode :read-only})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
### bind-filesystem!
|
### bind-filesystem!
|
||||||
Binds a path from your local filesystem into the Docker container as a volume
|
Binds a path from your local filesystem into the Docker container as a volume
|
||||||
|
|
||||||
|
|
@ -168,6 +179,9 @@ The `container-config`
|
||||||
:mode :read-only})
|
:mode :read-only})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
### copy-file-to-container!
|
### copy-file-to-container!
|
||||||
Copies a file from your filesystem or classpath into the running container
|
Copies a file from your filesystem or classpath into the running container
|
||||||
|
|
||||||
|
|
@ -194,6 +208,9 @@ The `container-config`
|
||||||
:type :host-path})
|
:type :host-path})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
### execute-command!
|
### execute-command!
|
||||||
Executes a command in the running container, and returns the result
|
Executes a command in the running container, and returns the result
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue