aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2023-05-24 21:18:39 -0500
committerChristian Cleberg <hello@cleberg.net>2023-05-24 21:18:39 -0500
commitb3286eb015079950554508e0724fd5f12c71833f (patch)
tree8ac93accb2465c0b3dc34e78686beeac879eaf68 /README.md
parent864f1349e47f924bcde20c1cc83d838b5c5c7316 (diff)
downloadifconfig.php-b3286eb015079950554508e0724fd5f12c71833f.tar.gz
ifconfig.php-b3286eb015079950554508e0724fd5f12c71833f.tar.bz2
ifconfig.php-b3286eb015079950554508e0724fd5f12c71833f.zip
add geolocation functionality
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index 39f6c48..e1231b3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-ifconfig.php
-============
+# ifconfig.php
**Simple PHP script to show IP address, UserAgent and other info**
@@ -27,3 +26,26 @@ With this code in the .htaccess file there is no need to type out the full URL,
Instead, you can just open 'ifconfig/xml' to get XML output or 'ifconfig/ua' to determine useragent.
Run `curl -L -X GET https://ip.cleberg.net/\?q\=text` in Linux terminal to get some info.
+
+## Development
+
+First, install PHP and Composer. For Fedora, run:
+
+```bash
+sudo dnf install php-cli composer
+```
+
+If applicable, install or update the maxmind-db dependency:
+
+```bash
+composer require maxmind-db/reader:~1.0
+
+# to update, run:
+composer update
+```
+
+Next, you can launch a dev server to test any of your changes:
+
+```bash
+sudo php --server localhost:8080 --docroot .
+```