Update README.md

This commit is contained in:
2013-06-01 16:32:50 +02:00
parent 3b4ccf3e70
commit 3406489d72

View File

@@ -8,7 +8,7 @@ Installation of the component:
* Extract the release file under `protected/extensions`
* Change main.php configuration file
```php
'components' => array(
...
'geoip' => array(
@@ -20,22 +20,22 @@ Installation of the component:
),
...
),
```
Usage instructions:
------------------------
All methods accept an IP address as an argument.
If no argument is supplied CHttpRequest::getUserHostAddress() is used.
```php
$location = Yii::app()->geoip->lookupLocation();
$countryCode = Yii::app()->geoip->lookupCountryCode();
$countryName = Yii::app()->geoip->lookupCountryName();
$org = Yii::app()->geoip->lookupOrg();
$regionCode = Yii::app()->geoip->lookupRegion();
```
Location attributes:
```php
$location->countryCode
$location->countryCode3
$location->countryName
@@ -47,14 +47,14 @@ Location attributes:
$location->longitude
$location->areaCode
$location->dmaCode
```
How to update Maxmind Free DBs example:
------------------------
`updateGeoIP.sh`
this script will only download if there is a new version of the database
```bash
cd /usr/local/share/GeoIP
wget -N -q http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
wget -N -q http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz
@@ -63,6 +63,6 @@ this script will only download if there is a new version of the database
gunzip -c GeoLiteCity.dat.gz > GeoLiteCity.dat
gunzip -c GeoIP.dat.gz > GeoIP.dat
gunzip -c GeoIPv6.dat.gz > GeoIPv6.dat
```
* Setup a cron job to run this script monthly.