hod/nbn-availability

NBN Availability Checker

NBN Availability Checker

, _(*1)

nbn-availability is a simple library to help check the availability of the National Broadband Network at a given location in Australia, _(*2)

The goal of the library is to provide a very simple interface to check whether the network is available, and if it is, what technology is being implemented at that location, _(*3)

System Requirements

You need PHP >= 7.1.0 to use this library due to scalar type hinting, _(*4)

Install

Install nbn-availability using Composer., _(*5)

``` bash $ composer require hod/nbn-availability, <sub>(*6)</sub>

Testing
-------

`nbn-avilability` has a [PHPUnit](https://phpunit.de) test suite and a coding 
style compliance test suite using [PHP CS Fixer](http://cs.sensiolabs.org/). 
To run the tests, run the following command from the project folder.

``` bash
$ composer test

Usage

``` php <?php require_once('vendor/autoload.php');, <sub>(*7)</sub>

use Hod\NbnAvailability\AvailabilityChecker;, <sub>(*8)</sub>

$checker = new AvailabilityChecker(); $availabilityStatus = $checker->checkAvailability(-37.8568731, 144.8961339); var_dump(json_encode($availabilityStatus)); ```, <sub>(*9)</sub>

License

The MIT License (MIT). Please see LICENSE for more information., <sub>(*10)</sub>