ssube
/
salty-dog
1
0
Fork 0
Code

fix(docs): disambiguate build/install headers

This commit is contained in:
ssube 2019-10-31 07:35:01 -05:00 committed by Sean Sube
parent 017dfd70e1
commit 47fe86604c
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,9 +8,11 @@ supports multiple documents per stream or file, inserting defaults, and other ma
- [Status](#status) - [Status](#status)
- [Releases](#releases) - [Releases](#releases)
- [Build](#build) - [Build](#build)
- [Local Build](#local-build)
- [Docker Build](#docker-build)
- [Install](#install) - [Install](#install)
- [Docker](#docker) - [Docker Install](#docker-install)
- [Node](#node) - [Yarn Install](#yarn-install)
- [Global](#global) - [Global](#global)
- [Project](#project) - [Project](#project)
- [Usage](#usage) - [Usage](#usage)
@ -86,7 +88,9 @@ ingress.extensions/gitlab created (dry run)
## Build ## Build
This project is written in Typescript and requires `node` and `yarn` to build. ### Local Build
This project is written in Typescript and requires `make`, `node`, and `yarn` to build.
```shell ```shell
> git clone git@github.com:ssube/salty-dog.git > git clone git@github.com:ssube/salty-dog.git
@ -112,11 +116,15 @@ After building, run with `node out/index.js` or install run as `salty-dog`:
ingress.extensions/gitlab created (dry run) ingress.extensions/gitlab created (dry run)
``` ```
### Docker Build
Build with Docker: Build with Docker:
```
```shell
# Stretch # Stretch
docker run --rm -v "$(pwd):/salty-dog" -w /salty-dog node:11-stretch make docker run --rm -v "$(pwd):/salty-dog" -w /salty-dog node:11-stretch make
docker build -t salty-dog:stretch -f Dockerfile.stretch . docker build -t salty-dog:stretch -f Dockerfile.stretch .
# Alpine # Alpine
docker run --rm -v "$(pwd):/salty-dog" -w /salty-dog node:11-alpine sh -c "apk add build-base && make" docker run --rm -v "$(pwd):/salty-dog" -w /salty-dog node:11-alpine sh -c "apk add build-base && make"
docker build -t salty-dog:alpine -f Dockerfile.alpine . docker build -t salty-dog:alpine -f Dockerfile.alpine .
@ -124,7 +132,7 @@ docker build -t salty-dog:alpine -f Dockerfile.alpine .
## Install ## Install
### Docker ### Docker Install
To run with Docker: `docker run --rm ssube/salty-dog:master` To run with Docker: `docker run --rm ssube/salty-dog:master`
@ -136,7 +144,7 @@ The Docker container is published for each branch and git tag, tagged with the g
Rules are baked into the image in `/salty-dog/rules`. To use custom rules, mount them with Rules are baked into the image in `/salty-dog/rules`. To use custom rules, mount them with
`-v $(pwd)/rules:/salty-dog/rules:ro` and load with `--rules /rules/foo.yml`. `-v $(pwd)/rules:/salty-dog/rules:ro` and load with `--rules /rules/foo.yml`.
### Node ### Yarn Install
#### Global #### Global