diff --git a/README.md b/README.md index 3be757f..a59d0e5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@

Sentra

-

The first autonomous source code posture risk score tool.

+

The first autonomous source code posture risk score tool

+ + + + + +

@@ -16,16 +22,6 @@ Sentra is a collection of Perl modules designed to help gain speed and increase --- -### Modules - -| Name | Description | -|------|-------------| -| DependabotMetrics | Fetches and analyzes Dependabot alerts from GitHub repositories of a specified organization. | -| SearchFiles | Checks repositories for specific files and last update times. | -| SlackWebhook | An output forwarder for sending messages to Slack via webhooks. | - ---- - ### Installation ```bash @@ -43,18 +39,25 @@ $ cpanm --installdeps . ``` $ perl sentra.pl -Sentra v0.0.1 +Sentra v0.0.3 Core Commands ============== Command Description ------- ----------- -o, --org Specify the name of the organization -t, --token Set the GitHub Token to use during actions --w, --webhook Set the webhook address for Slack --m, --message Message to send via Slack webhook -mt, --maintained Check last commit date of repositories -d, --dependency Check for dependabot.yaml file in repositories --p, --per_page Set the number of items per page in API requests (default: 100) +-M, --metrics See some metrics based on GHAS +-w, --webhook Set the webhook address for Slack +-m, --message Message to send via Slack webhook +``` + +--- + +### Workflows examples + +```yaml ``` --- @@ -67,4 +70,4 @@ Your contributions and suggestions are heartily ♥ welcome. [See here the contr ### License -This work is licensed under [MIT License.](/LICENSE.md) +This work is licensed under [MIT License.](/LICENSE.md) \ No newline at end of file