Skip to content

Commit 2ea4dff

Browse files
authored
docs: add demo
1 parent 928051a commit 2ea4dff

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Fortify your Digital Sphere, once command at a time
1010
## Table of Contents
1111

1212
- [Introduction](#introduction)
13+
- [Demo](#demo)
1314
- [Installation](#installation)
1415
- [npm](#npm)
1516
- [Docker Container](#docker-container)
@@ -24,7 +25,29 @@ Fortify your Digital Sphere, once command at a time
2425

2526
## Introduction
2627

27-
fortSphere is a tool designed to help you manage and fortify your digital sphere by applying various policies to your GitHub organization.
28+
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.
29+
30+
## Demo
31+
32+
### Scenario: While the Setup is fine using `restrictRepoCreationGitHub`
33+
34+
**GitHub UI (before)**
35+
![Screenshot from 2024-12-19 02-54-57](https://github.com/user-attachments/assets/c85cad6b-7fc9-4060-a723-8f48be10861a)
36+
37+
**fortSphere run and logs**
38+
![Screenshot from 2024-12-19 02-39-04](https://github.com/user-attachments/assets/fe483669-0228-46b4-8517-091f5f49b558)
39+
40+
---
41+
42+
### Scenario: When the setup requires changes using `restrictRepoCreationGitHub`
43+
44+
**GitHub UI (before)**
45+
![Screenshot from 2024-12-19 02-55-14](https://github.com/user-attachments/assets/8c92af79-ca25-473c-ad32-45e08157e6a6)
46+
47+
**fortSphere run and logs**
48+
![Screenshot from 2024-12-19 02-41-00](https://github.com/user-attachments/assets/59470423-2fad-4963-bf49-8d86118501ed)
49+
50+
---
2851

2952
## Installation
3053

@@ -110,4 +133,4 @@ fortSphere includes the following policies:
110133
Contributions are welcome! Please read the contributing guidelines first.
111134

112135
## License
113-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
136+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)