Skip to content

Commit 1c4f87c

Browse files
committed
Update README
1 parent 56fe53e commit 1c4f87c

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Table of contents
4141
* [GitHub token](#github-token)
4242
* [Tests](#tests)
4343
* [Dependency](#dependency)
44+
* [Docker](#docker)
4445
<!--te-->
4546

4647

@@ -381,23 +382,38 @@ Dependency
381382
Tested on Ubuntu 14.04/14.10 in bash/zsh.
382383
383384
Docker
384-
==========
385+
======
386+
387+
Local
388+
-----
385389
386390
* Build
387391
388392
```shell
389-
docker build -t markdown-toc-generator .
393+
$ docker build -t markdown-toc-generator .
390394
```
391395
392396
* Run on an URL
393397
394398
```shell
395-
docker run -it markdown-toc-generator https://github.com/ekalinin/envirius/blob/master/README.md
399+
$ docker run -it markdown-toc-generator https://github.com/ekalinin/envirius/blob/master/README.md
396400
```
397401
398402
* Run on a local file (need to share volume with docker)
399403
400404
```shell
401-
docker run -it -v /data/ekalinin/envirius:/data markdown-toc-generator /data/README.md
405+
$ docker run -it -v /data/ekalinin/envirius:/data markdown-toc-generator /data/README.md
402406
```
403407
408+
Public
409+
-------
410+
411+
```shell
412+
$ docker pull evkalinin/gh-md-toc:0.7.0
413+
414+
$ docker images | grep toc
415+
evkalinin/gh-md-toc 0.7.0 0b8db6aed298 11 minutes ago 147MB
416+
417+
$ docker run -it evkalinin/gh-md-toc:0.7.0 \
418+
https://github.com/ekalinin/envirius/blob/master/README.md
419+
```

0 commit comments

Comments
 (0)