From 2ea4dffa2cea46c01d10bc53e521b03542d10761 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulises=20Gasc=C3=B3n?= Date: Thu, 19 Dec 2024 05:12:17 +0100 Subject: [PATCH] docs: add demo --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d7d67f..4b3d668 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Fortify your Digital Sphere, once command at a time ## Table of Contents - [Introduction](#introduction) +- [Demo](#demo) - [Installation](#installation) - [npm](#npm) - [Docker Container](#docker-container) @@ -24,7 +25,29 @@ Fortify your Digital Sphere, once command at a time ## Introduction -fortSphere is a tool designed to help you manage and fortify your digital sphere by applying various policies to your GitHub organization. +fortSphere is a CLI tool designed to help you manage and fortify your digital sphere by applying various policies to your GitHub organization(s) and repositories. + +## Demo + +### Scenario: While the Setup is fine using `restrictRepoCreationGitHub` + +**GitHub UI (before)** +![Screenshot from 2024-12-19 02-54-57](https://github.com/user-attachments/assets/c85cad6b-7fc9-4060-a723-8f48be10861a) + +**fortSphere run and logs** +![Screenshot from 2024-12-19 02-39-04](https://github.com/user-attachments/assets/fe483669-0228-46b4-8517-091f5f49b558) + +--- + +### Scenario: When the setup requires changes using `restrictRepoCreationGitHub` + +**GitHub UI (before)** +![Screenshot from 2024-12-19 02-55-14](https://github.com/user-attachments/assets/8c92af79-ca25-473c-ad32-45e08157e6a6) + +**fortSphere run and logs** +![Screenshot from 2024-12-19 02-41-00](https://github.com/user-attachments/assets/59470423-2fad-4963-bf49-8d86118501ed) + +--- ## Installation @@ -110,4 +133,4 @@ fortSphere includes the following policies: Contributions are welcome! Please read the contributing guidelines first. ## License -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.