|
1 | | -GeoIP for Laravel [](https://github.com/ARCANEDEV/GeoIP/blob/master/LICENSE) |
2 | | -============== |
3 | | -[](https://travis-ci.org/ARCANEDEV/GeoIP) |
4 | | -[](https://scrutinizer-ci.com/g/ARCANEDEV/GeoIP/?branch=master) |
5 | | -[](https://scrutinizer-ci.com/g/ARCANEDEV/GeoIP/?branch=master) |
6 | | -[](https://github.com/ARCANEDEV/GeoIP/releases) |
7 | | -[](https://packagist.org/packages/arcanedev/geo-ip) |
8 | | -[](https://github.com/ARCANEDEV/GeoIP/issues) |
| 1 | +# GeoIP [![Packagist License][badge_license]](LICENSE.md) [![For ARCANEDEV][badge_laravel]](https://github.com/ARCANEDEV/GeoIP#geoip) |
9 | 2 |
|
10 | | -*By [ARCANEDEV©](http://www.arcanedev.net/)* |
11 | | - |
12 | | -### Requirements |
13 | | - |
14 | | - - PHP >= 5.4.0 |
15 | | - |
16 | | -### Composer |
17 | | - |
18 | | -You can install the package via [Composer](http://getcomposer.org/). Add this to your `composer.json`: |
19 | | - |
20 | | -```json |
21 | | -{ |
22 | | - "require": { |
23 | | - ... |
24 | | - "arcanedev/geo-ip": "~1.1" |
25 | | - } |
26 | | -} |
27 | | -``` |
28 | | - |
29 | | -Then install via `composer install` or `composer update`. |
30 | | - |
31 | | -### Laravel Installation |
32 | | -Once the package is installed, you can register the service provider in `app/config/app.php` in the `providers` array: |
| 3 | +[![Travis Status][badge_build]](https://travis-ci.org/ARCANEDEV/GeoIP) |
| 4 | +[![Coverage Status][badge_coverage]](https://scrutinizer-ci.com/g/ARCANEDEV/GeoIP/?branch=master) |
| 5 | +[![Scrutinizer Code Quality][badge_quality]](https://scrutinizer-ci.com/g/ARCANEDEV/GeoIP/?branch=master) |
| 6 | +[![SensioLabs Insight][badge_insight]](https://insight.sensiolabs.com/projects/4a10299d-26e2-4c86-8f39-9c3a3aa93e0f) |
| 7 | +[![Github Issues][badge_issues]](https://github.com/ARCANEDEV/GeoIP/issues) |
33 | 8 |
|
34 | | -```php |
35 | | -'providers' => [ |
36 | | - ... |
37 | | - 'Arcanedev\GeoIP\Laravel\ServiceProvider', |
38 | | -], |
39 | | -``` |
| 9 | +[![Packagist][badge_package]](https://packagist.org/packages/arcanedev/geoip) |
| 10 | +[![Packagist Release][badge_release]](https://packagist.org/packages/arcanedev/geoip) |
| 11 | +[![Packagist Downloads][badge_downloads]](https://packagist.org/packages/arcanedev/geoip) |
40 | 12 |
|
41 | | -And the facade in the `aliases` array: |
42 | | - |
43 | | -```php |
44 | | -'aliases' => [ |
45 | | - ... |
46 | | - 'GeoIP' => 'Arcanedev\GeoIP\Laravel\Facade', |
47 | | -], |
48 | | -``` |
49 | | - |
50 | | -#### Artisan Commands |
51 | | -There are 2 commands available through this package: |
52 | | -``` |
53 | | -php artisan geo-ip:install |
54 | | -``` |
55 | | - |
56 | | -Which simply migrate and seed all IPs and countries data for this package. Or |
| 13 | +*By [ARCANEDEV©](http://www.arcanedev.net/)* |
57 | 14 |
|
58 | | -``` |
59 | | -php artisan geo-ip:dump |
60 | | -``` |
| 15 | +GeoIP package for Laravel. |
61 | 16 |
|
62 | | -Which generate a SQL File for your database. |
| 17 | +Feel free to check out the [releases](https://github.com/ARCANEDEV/GeoIP/releases), [license](LICENSE.md), and [contribution guidelines](CONTRIBUTING.md). |
63 | 18 |
|
64 | | -### Configuration |
65 | | -Publish the package configuration by using this command: |
| 19 | +## Features |
66 | 20 |
|
67 | | -``` |
68 | | -php artisan config:publish arcanedev/geo-ip |
69 | | -``` |
| 21 | + - Coming soon… |
70 | 22 |
|
71 | | -Update your settings in the generated `app/config/packages/arcanedev/geo-ip` configuration file. |
| 23 | +## Security |
72 | 24 |
|
73 | | -```php |
74 | | -return [ |
75 | | - 'connection' => 'mysql', |
76 | | - 'prefix' => 'geo_', |
77 | | - 'table' => [ |
78 | | - 'nations' => 'nations', |
79 | | - 'countries' => 'countries', |
80 | | - ], |
81 | | - 'dump' => app_path() . '/database/geo-db.sql' |
82 | | -]; |
83 | | -``` |
| 25 | +If you discover any security related issues, please email arcanedev-maroc@gmail.com instead of using the issue tracker. |
84 | 26 |
|
85 | | -## USAGE |
86 | | -Coming soon ... |
| 27 | +## Contribution |
87 | 28 |
|
88 | | -### TODOS: |
| 29 | +Any ideas are welcome. Feel free to submit any issues or pull requests, please check the [contribution guidelines](CONTRIBUTING.md). |
89 | 30 |
|
90 | | - - [ ] Documentation |
91 | | - - [ ] Examples |
92 | | - - [x] More tests and code coverage |
93 | | - - [x] Laravel Support (v4.2) |
94 | | - - [ ] Laravel Support (v5.0) |
95 | | - - [ ] Refactoring |
| 31 | +[badge_laravel]: https://img.shields.io/badge/For-Laravel%205.x-orange.svg?style=flat-square |
| 32 | +[badge_license]: https://img.shields.io/packagist/l/arcanedev/geo-ip.svg?style=flat-square |
96 | 33 |
|
97 | | -### CREDIT |
| 34 | +[badge_build]: https://img.shields.io/travis/ARCANEDEV/GeoIP.svg?style=flat-square |
| 35 | +[badge_coverage]: https://img.shields.io/scrutinizer/coverage/g/ARCANEDEV/GeoIP.svg?style=flat-square |
| 36 | +[badge_quality]: https://img.shields.io/scrutinizer/g/ARCANEDEV/GeoIP.svg?style=flat-square |
| 37 | +[badge_insight]: https://img.shields.io/sensiolabs/i/4a10299d-26e2-4c86-8f39-9c3a3aa93e0f.svg?style=flat-square |
| 38 | +[badge_issues]: https://img.shields.io/github/issues/ARCANEDEV/GeoIP.svg?style=flat-square |
98 | 39 |
|
99 | | -Thanks to [ip2nation.com](http://ip2nation.com/) for the database. |
| 40 | +[badge_package]: https://img.shields.io/badge/package-arcanedev/geo--ip-blue.svg?style=flat-square |
| 41 | +[badge_release]: https://img.shields.io/packagist/v/arcanedev/geo-ip.svg?style=flat-square |
| 42 | +[badge_downloads]: https://img.shields.io/packagist/dt/arcanedev/geo-ip.svg?style=flat-square |
0 commit comments