diff --git a/README.md b/README.md index a431d16..cad8229 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 ``` diff --git a/ROADMAP.md b/ROADMAP.md index 67d982d..891c887 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -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 diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 51f601b..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,26 +0,0 @@ -# Security Policy for Privateer - -Version: **v0.1 (2023-08-14)** - -## Preface - -Privateer currently only supports non-production use cases. But in spite of that, the Privateer Project team places high value on security considerations, and is continuously working on improving it. - -## Supported Versions - -Until the official v1 release, we will not support any versions prior to the latest minor version. For example, we will add security patches to v0.3 until v0.4 is released. This documentation will be updated with the release of v1. - -## Reporting a Vulnerability - -If you find a security related bug in Privateer, we kindly ask you for -responsible disclosure and for giving us appropriate time to react, analyze and -develop a fix to mitigate the found security vulnerability. - -We will do our best to react quickly on your inquiry, and to coordinate a fix -and disclosure with you. Sometimes, it might take a little longer for us to -react (e.g. out of office conditions), so please bear with us in these cases. - -We will publish security advisories using the -[GitHub Security Advisories](https://github.com/privateerproj/privateer/security/advisories) -feature to keep our community well-informed, and will credit you for your -findings (unless you prefer to stay anonymous, of course).