From 382a9f3c7b333a972082725feae15a20b4ff9eab Mon Sep 17 00:00:00 2001 From: benemohamed Date: Thu, 2 May 2019 17:18:36 +0100 Subject: [PATCH] update --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 44 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09651bd..de5ab70 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,50 @@ To enable all the data fields and additional request volumes see [https://ipfind Visit [IPFinder documentation](https://ipfinder.io/docs). -## System Requirements & Installation +## System Requirements +- PHP >= 7.0 +- JSON PHP Extension +- CURL PHP Extension +- [official PHP library for IPfinder](https://github.com/ipfinder-io/ip-finder-php). +## Installation +### Via composer +First, download the IPfinder cli using Composer: +```php +composer global require ipfinder-io/ip-finder-cli +``` +Make sure to place composer's system-wide vendor bin directory in your `$PATH` so the laravel executable can be located by your system. This directory exists in different locations based on your operating system; however, some common locations include: +- macOS: `$HOME/.composer/vendor/bin` +- GNU / Linux Distributions: `$HOME/.config/composer/vendor/bin` +- Windows: `%USERPROFILE%\AppData\Roaming\Composer\vendor\bin` +### Linux Distributions / macOS +download the IPfinder cli using from github using curl +```bash +## using curl +$ curl -LO https://github.com/ipfinder-io/ip-finder-cli/releases/download/v1.0.0/ipfinder.phar +## using wget +$ wget https://github.com/ipfinder-io/ip-finder-cli/releases/download/v1.0.0/ipfinder.phar +$ chmod +x ipfinder.phar +$ sudo mv ipfinder.phar /usr/bin/ipfinder +$ ipfinder -h +``` +## Windows +1. Download [IPFINDER PHAR](https://github.com/ipfinder-io/ip-finder-cli/releases/download/v1.0.0/ipfinder.phar) from github +2. Create a directory for PHP binaries; e.g., `C:\bin` +3. Open a command line (e.g., press **Windows+R** » type `cmd` » ENTER) +4. Create a wrapping batch script (results in `C:\bin\ipfinder.cmd`): +```bash +C:\Users\username> cd C:\bin +C:\bin> echo @php "%~dp0ipfinder.phar" %* > ipfinder.cmd +C:\bin> exit +``` +5. Open a new command line and confirm that you can execute PHPUnit from any path: +```bash +C:\Users\username> ipfinder --help +```` -## License -## Support \ No newline at end of file +## License +Licensed under the [Apache-2.0](https://github.com/ipfinder-io/ip-finder-cli/blob/master/LICENSE). +## Support +Contact Us With Additional Questions About Our API, if you would like more information about our API that isn’t available in our IP geolocation API developer documentation, simply [contact](https://ipfinder.io/contact) us at any time and we’ll be able to help you find what you need.. \ No newline at end of file