Skip to content

Commit e91a2bc

Browse files
authored
Update README.md
1 parent f03e174 commit e91a2bc

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@
1818
</a>
1919
</p>
2020

21-
A lightweight, easy to deploy CTF framework (in Flask) for HackTheBox style machines.
21+
A fast, efficient and lightweight (~100 KB) Capture The Flag framework (in Flask) inspired by the [HackTheBox](https://hackthebox.eu/) platform.
22+
23+
The 100 second elevator-pitch is that: A Capture The Flag framework; one that is fast yet feature packed, efficient thus scalable, lightweight (insert some more pro developer adjectives) and customizable to your organization's brand while not emptying your bank A/C.
2224

23-
The main purpose of this project is to serve as a scoring engine and CTF manager.
2425

2526
**Want to see it in action?**
2627

@@ -32,7 +33,7 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
3233

3334
* Machines listing with fields: name, IP, OS, points and difficulty level.
3435
* Challenges listing with fields: title, description, URL, points.
35-
* Totally configurable settings such running time, organization details, CTF name.
36+
* Totally configurable settings such as running time, organization details, CTF name, etc.
3637
* Automatic strong password for administrator
3738
* Well implemented controls for administrators providing features such as issuing notifications, database CRUD operations, full fledged logging,
3839
* Simple User Registration/login process, account management, Forgot password functionalities,
@@ -45,7 +46,7 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
4546

4647
Please see [INSTALLATION.md](INSTALLATION.md).
4748

48-
## Host Your Own CTF in a minute with Heroku
49+
## Host a customized CTF with Heroku for free in under a minute
4950

5051
1. Sign up on [Heroku](https://heroku.com), if you haven't already and click on the below "Deploy to Heroku" button.
5152

@@ -63,6 +64,12 @@ Please see [INSTALLATION.md](INSTALLATION.md).
6364

6465
> Bonus: You can manage the database CRUD operations from admin views GUI; change machine settings, issue notifications to users, etc.
6566
67+
## Inspiration
68+
69+
The main purpose of this project is to serve as a scoring engine and CTF manager. One that is packed with features, can handle enterprise/global level traffic on a scalable yet [free heroku's dyno](#host-your-own-ctf-in-a-minute-with-heroku).
70+
71+
[CTFd](https://github.com/ctfd/ctfd) is one of the most popular CTF framework and we have used it for multiple engagements and will surely use it again. But at the same time, CTFd is heavy (~22.2 mb) (it gives poor performance even on a $49/mo heroku dyno) and nobody has $$$ to spend on cloud, especially students (like us). So, that's where RTB-CTF-Framework (~100 KB) comes in.
72+
6673
## Contributing
6774

6875
<p>
@@ -88,6 +95,7 @@ Please see [INSTALLATION.md](INSTALLATION.md).
8895

8996
For further guidelines, Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
9097

98+
9199
## Live Demo
92100

93101
**Live Demo:** <https://rtblivedemo.herokuapp.com/> (login with `admin:admin`)

0 commit comments

Comments
 (0)