refactor text

Author: Akshat0694

CHANGELOG.md

@@ -5,40 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - Unreleased
+## [1.0.0-alpha.1] - 2022-10-04
 
-### Fixed
-
-- Terraform binary not required for using OPA provider
-
-## [v1.0-beta.2] - 2021-01-12
-
-### Added
-
-- CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING
+- Initial realease of Tirith (StackGuardian Policy Framework)
 - Adopted Covenant Code of Conduct
 - cli wrapper for calling tirith
-- Summarized evaluation output and provides brief output formatting
-
-### Fixed
-
-- License content
-
-## [v1.0-beta.1] - 2021-07-10
-
-- Initial release of Tirith (SG Policy Framework).
-- New schema for policy declaration in JSON - V1.BETA
-- Tested for scanning terraform plans >= 0.14.6
-- Added Support for for evaluations using Rego:
-  > - str_equals_str
-  > - str_contains_str
-  > - str_contains_str
-  > - equals_null
-  > - str_matches_regex
-  > - bool_equals_bool
-  > - cidr_contains_cidr_or_ip
 
----
 
 ## Types of changes
 
@@ -54,6 +26,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 **Security**: in case of vulnerabilities.
 
-[unreleased]: https://github.com/StackGuardian/tirith/compare/v1.0-beta.2...HEAD
-[v1.0-beta.1]: https://github.com/StackGuardian/tirith/compare/v1.0-beta.1
-[v1.0-beta.2]: https://github.com/StackGuardian/tirith/compare/v1.0-beta.2
+[unreleased]: https://github.com/StackGuardian/tirith/compare/1.0.0-alpha.1...HEAD
+[1.0.0-alpha.1]: https://github.com/StackGuardian/tirith/compare/1.0.0-alpha.1

LICENSE

@@ -176,7 +176,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2021 StackGuardian
+   Copyright 2022 StackGuardian
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -14,9 +14,9 @@ Tirith scans declarative Infrastructure as Code (IaC) configurations like Terraf
 ## Content
 
 - [Features](#features)
-- [Feature Road-Map](#feature-road-map)
+<!-- - [Feature Road-Map](#feature-road-map) -->
 - [How to use it?](#how-to-use-it)
-- [Local Development Environment](#local-development-environment)
+<!-- - [Local Development Environment](#local-development-environment) -->
 - [Want to contribute?](#want-to-contribute)
   - [Getting an issue assigned](#getting-an-issue-assigned)
   - [A bug report](#a-bug-report)
@@ -27,30 +27,38 @@ Tirith scans declarative Infrastructure as Code (IaC) configurations like Terraf
 
 ## Features
 
-- A simple interface to define compliance policies as declarative config, which can be enforced proactively on Infrastructure as Code to detect breaches.
-- Pluggable architecture allows to integrate into policy engines like OPA for policy evaluation.
-- Summarizes evaluation output and provides brief output formatting.
-- Cli support with data and input as arguments.
-- Very easy to use.
-- Works on Mac, Linux and Windows.
+- An easy to read and simple way to define policy as code against structured formats.
+- Use providers to define policies for terraform plan, infracost or any abstract JSON.
+- Easily evaluate inputs against policy using pre-defined evaluators like ContainedIn, Equals, RegexMatch etc.
+- Write your own provider (plugin) by leveraging a highly extensible and pluggable architecture to support any input formats.
 
-## Feature Road-map
+<!-- ## Feature Road-map
 
-This is only a list of approved features that will be included in Tirith over the next few months.
+This is only a list of approved features that will be included in Tirith over the next iterations.
 
-- Support for CloudFormation config scanning
-- Support for ARM config scanning
-- Extended library of evaluator functions
+- Extended support for Terraform Plan
+- Support for Cloudformation and ARM
+- Extended library of evaluator functions -->
 
 ## How to use it?
+```
+usage: tirith [-h] [-policy-path PATH] [-input-path SOURCE-TYPE] [--json] [--verbose] [--version]
 
-## Local Development Environment
+Tirith (StackGuardian Policy Framework)
 
-- Any operating system is supported(Windows, Mac, or Linux).
-- [Python 3.6 or higher](https://www.python.org/downloads/) is required.
-- [pip](https://pip.pypa.io/en/stable/) is required.
+optional arguments:
+  -h, --help               show this help message and exit
+  -policy-path PATH        Path containing Tirith policy as code
+  -input-path SOURCE-TYPE  Input file path
+  --json                   Only print the result in JSON form (useful for passing output to other programs)
+  --verbose                Show detailed logs of from the run
+  --version                show program's version number and exit
+```
+
+<!-- ## Local Development Environment
 
-And leave the rest to us!!!
+- [Python 3.6 or higher](https://www.python.org/downloads/) is required.
+- [pip](https://pip.pypa.io/en/stable/) is required. -->
 
 <!-- ## Publish Package on test.pypi.org
 * Use the following command to install the latest version of the setuptools package.
@@ -74,6 +82,8 @@ And leave the rest to us!!!
 
 ## Want to contribute?
 
+If you're interested, please email us at team[at]stackguardian.io or get started by reading the [contributing.md](./CONTRIBUTING.md).
+
 ### Getting an issue assigned
 
 Go to the <a href="https://github.com/StackGuardian/tirith">Tirith Repository</a> and in the <a href="https://github.com/stackguardian/tirith/issues">issues</a> tab describe any bug or feature you want to add. If found relevant, the maintainers will assign the issue to you and you may start working on it as mentioned in the next section.