Skip to content

Commit

Permalink
chore: edit markdown files (#41)
Browse files Browse the repository at this point in the history
- [x] remove SECURITY.md (moved to privateerproj/.github repo)
- [x] update some formatting typos in other markdownf files

Signed-off-by: jmeridth <[email protected]>
  • Loading branch information
jmeridth authored Dec 12, 2024
1 parent fa09c6a commit 6cb4eb3
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 30 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

# Privateer

### Simplifying Validation for Infrastructure Engineers
## Simplifying Validation for Infrastructure Engineers

Privateer has been meticulously crafted with infrastructure engineers in mind. If you're seeking to validate your resources against regulations, taxonomies, or standards, Privateer is your trusted companion. With a user-friendly interface and powerful features, you can now effortlessly navigate the complexities of resource validation.

### Using Privateer Raids
## Using Privateer Raids

There are several key benefits to Privateer Raids:

Expand Down Expand Up @@ -40,13 +40,14 @@ To build privateer from source, follow these steps below:
cd privateer
```

2. Installting Dependencies
2. Installing Dependencies

```sh
go mod tidy
```

3. Building Privateer

```sh
make release
```
Expand Down
2 changes: 1 addition & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This roadmap should be moved into a GitHub Project before v0.3.

### Bugfixes

- [x] unecessary error message when no config was supplied (skipping the config file may be intentional, or maybe not)
- [x] unnecessary error message when no config was supplied (skipping the config file may be intentional, or maybe not)
- [x] config wasn't being used in raid
- [x] Corrected -v usage and removed any instance of `log` in favor of `logger`. Basic `log` should not be used due to persistent unexpected behavior.
- [x] default loglevel is now error
Expand Down
26 changes: 0 additions & 26 deletions SECURITY.md

This file was deleted.

0 comments on commit 6cb4eb3

Please sign in to comment.