Skip to content

README revised to include docker related usage guide #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,27 @@ md2csv https://raw.githubusercontent.com/cabforum/documents/master/docs/BR.md ht

Using [pdf2md](http://pdf2md.morethan.io/) you can convert a PDF document to Markdown so that you can use it with `md2csv`.


## Using Docker

### Downloading the docker image
```bash
docker pull digitorus/md2csv
```

### Running the docker image
```bash
docker run -ti digitorus/md2csv sh
```
After this you can use the `md2csv` command from above.

### Running the command
The above command will open a shell in the Docker container. To execute the command `md2csv`, use `./` before the command as following:
```bash
./md2csv {url|filename}
```

### Copying files to/from Docker image
The subject file from your local/host filesystem needs to be copied to the docker filesystem to execute the above command.For this purpose, `docker cp` command can be used. `Docker cp --help` can be used to get more information about the command.

## Reconnect Docker image
```bash
Expand Down