README.md in docker-spoon-0.2.0 vs README.md in docker-spoon-0.3.0
- old
+ new
@@ -47,15 +47,16 @@
You may also specify a different config file with the `--config`
argument.
## Usage
-Spoon has 4 major operations it can perform:
+Spoon has 5 major operations it can perform:
- Connect/Create, Connect to an existing spoon container or create a new
container
- List, List existing containers
+- Network, Show ports forwarded to existing containers
- Build, Build an image for use as a spoon container
- Destroy, Destroy an existing spoon container
### Connect/Create
@@ -79,10 +80,14 @@
$ spoon fortesting
Connecting to `spoon-fortesting`
pairing@dockerhost's password:
```
+NOTE: If a container has been stopped due to a machine restart or other
+reason, spoon will issue a start to the container & then attempt to ssh
+in.
+
#### Options
- `--url`, The url of the Docker API endpoint. This is in the format
supported by the docker -H option. This will also read from the
environment variable `DOCKER_HOST` if this argument is not specified
@@ -99,23 +104,41 @@
can see only the containers you are interested in.
```shell
$ spoon -l
List of available spoon containers:
-fortesting
+ booger [ Stopped ]
+ jake [ Running ]
+ test [ Stopped ]
```
+You can connect to Stopped containers in the same way as Running
+containers, spoon will re-start them as necessary.
+
### Destroy
The `--destroy NAME` option will destroy the specified spoon container.
```shell
$ spoon -d fortesting
Destroying spoon-fortesting
Done!
```
+### Network
+
+The `--network NAME` option will show the forwarded ports for a spoon
+instance. Any ports listed via `EXPOSE` in your Dockerfile should be
+exposed when a spoon container is started. If you are working with
+applications in a spoon container you can use this to forward ports &
+view what public ports are forwarded for your spoon container.
+
+```
+$ spoon -n jake
+22 -> 49213
+```
+
### Build
The `--build` option will build a docker image from the build directory
specified by `--builddir` (default '.'). This has the same expectations
as the [docker
@@ -154,10 +177,10 @@
creates an image which runs ssh is included in the `docker/`
directory inside this repository
## Contributing
-1. Fork it ( https://github.com/adnichols/spoon/fork )
+1. Fork it ( https://github.com/adnichols/docker-spoon/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request