mnrahimi/softearth

SoftEarth object-oriented PHP library.

dev-master / 0.1.x-dev 2016-12-03 10:59 UTC

This package is not auto-updated.

Last update: 2024-11-09 20:39:41 UTC


README

Build Status Latest Stable Version Latest Unstable Version License

SoftEarth

An object-oriented PHP library for managing geographical (earth specific) data.

The Idea

The idea behind SoftEarth is that I want to create an object-oriented PHP library for accessing, manipulating and managing geographical data like country, state (province), city and the related properties and attributes like country's currency and all the nested data to each object.

SoftEarth will greatly help any application or website project where the app is interacting with some kind of geographical data the most significant example is a registeration behaviour where in most signup or registeration procedures country or some other kind of SoftEarth data is necessary.

Requirements

The SoftEarth PHP library has the following requirements:

  • PHP 5.6+

Installation

For using SoftEarth within your projects we recommend to install it using composer.

$ composer require mnrahimi/softearth

Note: Currently SoftEarth can not be installed by composer require because we don't have any stable release till now, so for the purpose of test you may install it as:

$ composer create-project mnrahimi/softearth SoftEarth dev-master

Basic Usage

Comming soon...

Contribution

Any contribution will be greatly appreciated. Currently there are no specific contribution guidelines ready though for the sake of contribution you have to go through the project source code.

Thanks in advance,
Muhammad Nasir Rahimi

License

SoftEarth is released under the MIT Licence. See the bundled LICENSE file for details.