Where is the documentation for using this package?

[marlongichie]

No description provided.

[stevendesu]

Good question. I haven't made any documentation yet (and you're welcome to help me build some if you'd like).

I'm brand new to Laravel and even newer to Composer, so as I was working on a project that required simple distance calculations using longitude and latitudes I saw it as a good opportunity to get more familiar with Composer. This was mostly a tool that I built for myself as a learning exercise, and posted on packagist to get a better understanding for how packagist works and how the submission process works.

As such I never sat down to write a documentation for it. If you're interested in a brief documentation for the time being, it's essentially:

1. Add this package to your composer.json ("stevendesu/world-distance": "dev-master" -- if you can teach me how to publish official versions I would be appreciative because I would prefer "0.1.0" to "dev-master")
2. Install the service provider (edit /config/app.php and add "Stevendesu\WorldDistance\WorldDistanceServiceProvider" to your service providers then add "WorldDistance" => "Stevenesu\WorldDistance\WorldDistanceFacade" to your facades)
3. Run php artisan vendor:publish to copy the default config file (this specifies the radius of the earth and inherently specifies the desired units of the output)
4. To use: WorldDistance::getDistance( [$lat1, $lng1], [$lat2, $lng2] ) within your app (will return the distance between two points on the globe)