From 1d297dea4dfba256f0dbbb19604a2136f629fddc Mon Sep 17 00:00:00 2001 From: "15070724+qubitz@users.noreply.github.com" <15070724+qubitz@users.noreply.github.com> Date: Sun, 23 May 2021 23:41:02 -0700 Subject: [PATCH] Add readme * Description * Services * Chocolatey * Fancy badges --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..26f1d1d --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Lawyer ⚖️ +![Chocolatey Version](https://img.shields.io/chocolatey/v/lawyer) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/qubitz/lawyer/LICENSE.txt) + +A tool for maintaining file headers in egregious violation of strict standards. + +## Pro bono services + +### Indictments 🔍 + +Analyze files to find headers that don't meet the strict criteria as specified in +the [Law](#terms). + +``` +lawyer indict file.txt # single file +lawyer indict *.txt # or multiple files with globbing +``` +Output: +``` +searching for the law...found ./law.yaml +fail.txt is guilty + +evidence +-------------------------------------------------- +/// +/// ABC © 2021. All rights reserved. +///