1
0
Fork 0

docs: add repo url, fix example command

This commit is contained in:
ssube 2019-06-15 18:33:50 -05:00
parent f50f2f13f8
commit 2e6b55ce9c
3 changed files with 10 additions and 15 deletions

View File

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2018 Sean Sube
Copyright (c) 2019 Sean Sube
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -1,7 +1,7 @@
# SALTY DOG
**S**chema **a**nalysis, **l**inting, and **t**ransformation for **Y**AML with **d**efaults, **o**ptional fields, and
other **g**ood stuff.
JSON **s**chema **a**nalysis, **l**inting, and **t**ransformation for **Y**AML, featuring **d**efaults, **o**ptional
fields, and other **g**ood stuff.
- [SALTY DOG](#salty-dog)
- [Build](#build)
@ -20,18 +20,17 @@ other **g**ood stuff.
## Build
```shell
> git clone
> make bundle
> git clone git@github.com:ssube/salty-dog.git
> make
```
## Usage
```shell
> cat rules/examples/kubernetes-require-resources-pass.yml |\
node out/bundle.js \
--rules rules/kubernetes.yml \
--source - \
--tag important
> cat rules/examples/kubernetes-require-resources-pass.yml | salty-dog \
--rules rules/kubernetes.yml \
--source - \
--tag important
```
### Options

View File

@ -23,17 +23,13 @@ rules:
properties:
cpu:
type: string
default: 100m
memory:
type: string
default: 256Mi
requests:
type: object
required: [cpu, memory]
properties:
cpu:
type: string
default: 100m
memory:
type: string
default: 256Mi
type: string