README.md

README.md

@@ -0,0 +1,39 @@
+# iPClientWeb
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+-- PHP 5.7 or greater
+-- Web server
+-- Obtain ip2location.io api key(It's free!)
+``` Link ``` 
+https://www.ip2location.io/
+
+### Installing
+
+1. Obtain the download file/source (usually .zip file).
+2. Extract the zip file
+
+#### File structure
+
+ 📂 iPClientWeb/
+    📂 htdocs/
+       📂 local/
+       -- .htaccess
+       -- functions.php
+    -- index.php
+    -- iPClientWeb-logo.png
+ -- README.md
+
+3. You may move all files and folders in the htdocs to your server/website public directory or you may configure your server to point to the htdocs folder
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+
+## Authors
+
+* **TheAlgoslingers**