Skip to content

Commit

Permalink
doc enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
jmccarthy committed Mar 16, 2019
1 parent ef7a409 commit e8d6d53
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ minor-release: release-env minor release

docker-release:
docker build --build-arg COMPLY_VERSION=`cat VERSION` -t strongdm/comply .
docker push strongdm/comply

patch: clean gitsem
gitsem -m "increment patch for release (via Makefile)" patch
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,18 @@ COMMANDS:
Comply is currently only released for Linux and macOS, however from other operating systems it's possible to run using Docker:

```
# first build a copy of the container using the included Dockerfile in the root of this project
$ docker build -t comply .
# first pull the latest published docker image
$ docker pull strongdm/comply
# from an empty directory that will contain your comply project
$ docker run -it --rm -v "$PWD":/source comply
$ docker run --rm -v "$PWD":/source -p 4000:4000 -it strongdm/comply
root@ec4544732298:/source# comply init
✗ Organization Name:
# serve content live from an established project
$ docker run --rm -v "$PWD":/source -p 4000:4000 -it strongdm/comply
root@ae4d499583fc:/source# comply serve
Serving content of output/ at http://127.0.0.1:4000 (ctrl-c to quit)
```

For Windows users, replace $PWD with the full path to your project directory
Expand Down

0 comments on commit e8d6d53

Please sign in to comment.