Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
* Description
* Services
* Chocolatey
* Fancy badges
  • Loading branch information
qubitz committed May 24, 2021
1 parent 3ba6fd3 commit 1d297de
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
--------------------------------------------------
/// <copyright file="file.txt" company="ABC">
/// ABC © 2021. All rights reserved.
/// </copyright
--------------------------------------------------
indictment complete
```

## Procurement process

### [Chocolatey](https://community.chocolatey.org/packages/lawyer)

like yum or apt-get, but for Windows
```
choco install lawyer
```

## Terms

Term | Definition
---- | ----------
Law | A file that specifies how file headers should look. See `lawyer help law` for more information.

0 comments on commit 1d297de

Please sign in to comment.