README

nbn-availability is a simple library to help check the availability of the National Broadband Network at a given location in Australia

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

System Requirements

You need PHP >= 7.1.0 to use this library due to scalar type hinting

Install

Install nbn-availability using Composer.

$ composer require hod/nbn-availability

Testing

nbn-avilability has a PHPUnit test suite and a coding style compliance test suite using PHP CS Fixer. To run the tests, run the following command from the project folder.

$ composer test

Usage

<?php
require_once('vendor/autoload.php');

use Hod\NbnAvailability\AvailabilityChecker;

$checker = new AvailabilityChecker();
$availabilityStatus = $checker->checkAvailability(-37.8568731, 144.8961339);
var_dump(json_encode($availabilityStatus));

License

The MIT License (MIT). Please see LICENSE for more information.