From 2e6b55ce9cf8ffd07be188911a63bb3eb45a4ca2 Mon Sep 17 00:00:00 2001 From: ssube Date: Sat, 15 Jun 2019 18:33:50 -0500 Subject: [PATCH] docs: add repo url, fix example command --- LICENSE.md | 2 +- README.md | 17 ++++++++--------- rules/kubernetes.yml | 6 +----- 3 files changed, 10 insertions(+), 15 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 3ead5f0..66373b1 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -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 diff --git a/README.md b/README.md index 7bef7c4..502f0e9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/rules/kubernetes.yml b/rules/kubernetes.yml index 9df7246..c931cbc 100644 --- a/rules/kubernetes.yml +++ b/rules/kubernetes.yml @@ -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 \ No newline at end of file + type: string \ No newline at end of file