Skip to content

Commit

Permalink
docs: add demo
Browse files Browse the repository at this point in the history
  • Loading branch information
UlisesGascon authored Dec 19, 2024
1 parent 928051a commit 2ea4dff
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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.
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 comments on commit 2ea4dff

Please sign in to comment.