aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Hiar <thornycrackers@users.noreply.github.com>2019-01-14 20:02:35 -0700
committerGitHub <noreply@github.com>2019-01-14 20:02:35 -0700
commit1403edd9d26ec8d19fd49eb59d55f9abf3c62558 (patch)
tree769099c63bc08803c67114f2c605074b19b980c6
parent531c468f661eb4dfbe49e80bd40ea304db314b4d (diff)
Update README.md
-rw-r--r--README.md31
1 files changed, 15 insertions, 16 deletions
diff --git a/README.md b/README.md
index 920060d..cb0cce6 100644
--- a/README.md
+++ b/README.md
@@ -16,19 +16,18 @@ project from this repo.
$ cookiecutter https://github.com/thornycrackers/cookiecutter_docker.git
```
-After that if you have `docker` and `make` installed you can simply use the
-following Makefile commands to start running the project.
-
-```bash
-$ make build
-$ make up
-$ make enter
-$ make down
-$ make clean
-```
-
-- build: Build the docker container
-- up: Spin up the docker container
-- enter: Enter the running container
-- down: Spin down the container but down remove
-- clean: Remove a stopped container
+You will be asked for a project name as well a a docker user. The project name
+can be what ever you want and the docker user will be the prefix you use for
+your images on dockerhub. E.g. My docker images are usually `thornycrackers/proj`
+so I would use `thornycrackers`. After that you will have a new project setup
+that includes a preset `docker-compose.yml` with a simple `Dockerfile` and a
+`Makefile` that will automate controlling the container. The following commands
+work out of the box.
+
+`make build` - Build your `docker_user/proj_name` image
+`make up` - Spin up your container and forwards port 8000 by default and mounts local file
+`make enter` - Open a bash terminal in the container
+`make down` - Stop the container
+`make clean` - Remove the stopped container
+
+[1]: https://github.com/audreyr/cookiecutter