Skip to content

Commit

Permalink
Adds pipeline badges and improves documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dsposito committed Apr 14, 2017
1 parent f7a11da commit 07a764f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
# Argo
[![Build Status](https://travis-ci.org/dsposito/argo.svg?branch=master)](https://travis-ci.org/dsposito/argo)
[![Coverage Status](https://coveralls.io/repos/github/dsposito/argo/badge.svg?branch=master)](https://coveralls.io/github/dsposito/argo?branch=master)
[![Latest Stable Version](https://poser.pugx.org/dsposito/argo/v/stable.png)](https://packagist.org/packages/dsposito/argo)

## Overview
Argo is a useful utility for shipping-related tasks. In particular, it deduces the shipping carrier, provider and other information based on a provided package tracking number.

In [Greek mythology](http://en.wikipedia.org/wiki/Argo), Argo (in Greek, meaning 'swift') was the ship on which Jason and the Argonauts sailed from Iolcos to retrieve the Golden Fleece. Argo was said to have been planned with the help of Athena - constructed with magical pieces of timber from the sacred forest of Dodona.

## Installation
Run the following [composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) command to add the package to your project:

```
composer require dsposito/argo
```

Alternatively, add `"dsposito/argo": "^2.0"` to your composer.json file.

## Usage
Simply provide a tracking number when initializing a new package instance.

Expand All @@ -18,6 +31,7 @@ Example output:
```
Argo\Package Object
(
[tracking_code_original] => 420 90401 9405 5108 9841 6000 5592 67
[tracking_code] => 9405510898416000559267
[carrier] => Argo\Carrier Object
(
Expand All @@ -31,3 +45,11 @@ Argo\Package Object
)
)
```

## Tests
To run the test suite, run the following commands from the root directory:

```
composer install
vendor/bin/phpunit
```

0 comments on commit 07a764f

Please sign in to comment.