fix(docs): put contents in section, use yarn-global target
This commit is contained in:
parent
7187cac40c
commit
84d2ba470b
67
README.md
67
README.md
|
@ -1,34 +1,8 @@
|
||||||
# SALTY DOG
|
# SALTY Dog
|
||||||
|
|
||||||
Rule-based JSON/YAML validator using JSON schemas. Capable of filtering elements to validate partial documents,
|
Rule-based JSON/YAML validator using JSON schemas. Capable of filtering elements to validate partial documents,
|
||||||
supports multiple documents per stream or file, inserting defaults, and other magic.
|
supports multiple documents per stream or file, inserting defaults, and other magic.
|
||||||
|
|
||||||
- [SALTY DOG](#salty-dog)
|
|
||||||
- [Getting Started](#getting-started)
|
|
||||||
- [Status](#status)
|
|
||||||
- [Releases](#releases)
|
|
||||||
- [Build](#build)
|
|
||||||
- [Local Build](#local-build)
|
|
||||||
- [Docker Build](#docker-build)
|
|
||||||
- [Install](#install)
|
|
||||||
- [Docker Install](#docker-install)
|
|
||||||
- [Yarn Install](#yarn-install)
|
|
||||||
- [Global](#global)
|
|
||||||
- [Project](#project)
|
|
||||||
- [Usage](#usage)
|
|
||||||
- [Logs](#logs)
|
|
||||||
- [Modes](#modes)
|
|
||||||
- [Check Mode](#check-mode)
|
|
||||||
- [Fix Mode](#fix-mode)
|
|
||||||
- [Default Values](#default-values)
|
|
||||||
- [Coercing Values](#coercing-values)
|
|
||||||
- [List Mode](#list-mode)
|
|
||||||
- [Rules](#rules)
|
|
||||||
- [Enable Rules](#enable-rules)
|
|
||||||
- [Load Rules](#load-rules)
|
|
||||||
- [Validate Rules](#validate-rules)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
`salty-dog` is distributed as a package and container, and can be installed or pulled:
|
`salty-dog` is distributed as a package and container, and can be installed or pulled:
|
||||||
|
@ -58,6 +32,35 @@ To download, validate, and apply a Kubernetes resource:
|
||||||
ingress.extensions/gitlab created (dry run)
|
ingress.extensions/gitlab created (dry run)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [SALTY Dog](#salty-dog)
|
||||||
|
- [Getting Started](#getting-started)
|
||||||
|
- [Contents](#contents)
|
||||||
|
- [Status](#status)
|
||||||
|
- [Releases](#releases)
|
||||||
|
- [Build](#build)
|
||||||
|
- [Local Build](#local-build)
|
||||||
|
- [Docker Build](#docker-build)
|
||||||
|
- [Install](#install)
|
||||||
|
- [Docker Install](#docker-install)
|
||||||
|
- [Yarn Install](#yarn-install)
|
||||||
|
- [Global](#global)
|
||||||
|
- [Project](#project)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Logs](#logs)
|
||||||
|
- [Modes](#modes)
|
||||||
|
- [Check Mode](#check-mode)
|
||||||
|
- [Fix Mode](#fix-mode)
|
||||||
|
- [Default Values](#default-values)
|
||||||
|
- [Coercing Values](#coercing-values)
|
||||||
|
- [List Mode](#list-mode)
|
||||||
|
- [Rules](#rules)
|
||||||
|
- [Enable Rules](#enable-rules)
|
||||||
|
- [Load Rules](#load-rules)
|
||||||
|
- [Validate Rules](#validate-rules)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
[![Pipeline status](https://img.shields.io/gitlab/pipeline/ssube/salty-dog.svg?gitlab_url=https%3A%2F%2Fgit.apextoaster.com&logo=gitlab)](https://git.apextoaster.com/ssube/salty-dog/commits/master)
|
[![Pipeline status](https://img.shields.io/gitlab/pipeline/ssube/salty-dog.svg?gitlab_url=https%3A%2F%2Fgit.apextoaster.com&logo=gitlab)](https://git.apextoaster.com/ssube/salty-dog/commits/master)
|
||||||
|
@ -106,14 +109,9 @@ This project is written in Typescript and requires `make`, `node`, and `yarn` to
|
||||||
> make
|
> make
|
||||||
```
|
```
|
||||||
|
|
||||||
After building, run with `node out/index.js` or install run as `salty-dog`:
|
After building, run with `node out/index.js` or install globally with `make yarn-global`.
|
||||||
|
|
||||||
```shell
|
`make` targets are provided for some example arguments:
|
||||||
> cd salty-dog
|
|
||||||
> yarn global add file:$(pwd)
|
|
||||||
```
|
|
||||||
|
|
||||||
`make` targets are provided for some common arguments:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
> curl https://raw.githubusercontent.com/ssube/k8s-shards/master/roles/apps/gitlab/server/templates/ingress.yml | \
|
> curl https://raw.githubusercontent.com/ssube/k8s-shards/master/roles/apps/gitlab/server/templates/ingress.yml | \
|
||||||
|
@ -356,4 +354,5 @@ To validate the rules in the `rules/` directory using the meta-rules:
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fssube%2Fsalty-dog.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fssube%2Fsalty-dog?ref=badge_large)
|
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fssube%2Fsalty-dog.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fssube%2Fsalty-dog?ref=badge_large)
|
||||||
|
|
Loading…
Reference in New Issue