Skip to content

Commit 99657c2

Browse files
committed
update readme
1 parent aa12792 commit 99657c2

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
<h2>Description:</h2>
1+
## Description:
22
PHPFirewall is a tool to allow/block connections to your web resource using IP address. The IP address details are either retrieved from local database or by making API calls to IP2Location.io
33

4-
<h2>Code Example:</h2>
4+
## Why this project?
5+
Internet is ever growing. New devices are coming online everyday which requires the ISPs to add new network range into their system. This makes it quite difficult for firewalls like Cisco or pfsense (linux) to manage policies or know about all networks that are introduced by the ISP of a particular region. Most network hacking happens because of incorrect/failed firewall rules. It's just hard to know all of the network IP ranges of a region.
56

7+
I wanted to create a firewall application that can be installed on shared hosting, that does not require physical access to the hardware or require a dedicated hardware to run. PHPFirewall can run in a shared hosting environment like Cpanel and it will work just fine. Most Cpanel providers provide access to the users space via SSH, so managing the firewall via CLI is possible.
8+
9+
The whole idea is not to worry about which IP belongs to which part of the world. 1 line should be enough to allow connection from that region and the firewall should take care of the rest of the connections by blocking them.
10+
Ip2location.io API along with this application - PHPFirewall, makes this possible.
11+
12+
## Code Example:
613
```php
714
//In index.php
815
<?php
@@ -19,11 +26,11 @@ if (!(new \PHPFirewall\Firewall)->checkIp()) {
1926
// Rest of your code
2027
```
2128

22-
<h2>Documentation:</h2>
29+
## Documentation:
2330

2431
[Documentation for this repository](https://github.com/oyeaussie/PHPFirewall/wiki/1.-Description)
2532

26-
<h2>Credits:</h2>
33+
## Credits:
2734
Thanks to the following projects for their great work. Without them, this project would not be possible.<br>
2835

2936
Composer<br>
@@ -39,17 +46,17 @@ Carbon Date : https://carbon.nesbot.com/<br>
3946
Codeception : https://codeception.com/<br>
4047
PHPUnit : https://phpunit.de/<br>
4148

42-
<h2>Issues/Discussions/New features:</h2>
49+
## Issues/Discussions/New features:
4350
Feel free to open an issue in case of a bug or to discuss anything related to the tool or to add a new feature.
4451

45-
<h2>Buy Me A Coffee/Beer:</h2>
52+
## Buy Me A Coffee/Beer:
4653
Time is valuable. If you feel this project has been helpful and it has saved your time worth a coffee or a beer...<br><br>
4754
<a href="https://www.buymeacoffee.com/oyeaussie" target="_blank"><img src="https://github.com/oyeaussie/assets/blob/main/buymecoffee.jpg" alt="Buy Me A Coffee"></a>
4855
<a href="https://github.com/sponsors/oyeaussie?frequency=one-time&sponsor=oyeaussie&amount=10" target="_blank"><img src="https://github.com/oyeaussie/assets/blob/main/buymebeer.jpg" alt="Buy Me A Beer"></a>
4956

50-
<h2>Hire me:</h2>
57+
## Hire me:
5158
If you would like to develop a PHP application that requires expert level programming. I am available for hire. Message me and we can discuss further.
5259

53-
<h2>Repo Activity:</h2>
60+
## Repo Activity:
5461

5562
![Repo Activity](https://repobeats.axiom.co/api/embed/b697a39a301be8feae16fcdf29cb428864b7188b.svg "Repo Activity")

0 commit comments

Comments
 (0)