basic usage docs page - refs #5

alcohol · Sep 14, 2016 · c6a947b · c6a947b
1 parent ebb5f00
commit c6a947b
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 4 deletions.
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
@@ -1,4 +1,5 @@
 Getting Started:
     Introduction: /
     Installing: /installing
+    Using: /using
     Contributing: /contributing
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,10 +1,10 @@
 ---
 layout: default
 permalink: /contributing
-title: Contributing
+title: Contributing to league/iso3166
 ---
 
-# Contributing
+# Contributing to league/iso3166
 
 Fork the [project](https://github.com/thephpleague/iso3166), create a feature branch, and send a pull request.
 

diff --git a/docs/installing.md b/docs/installing.md
@@ -1,10 +1,10 @@
 ---
 layout: default
 permalink: /installing
-title: Installing
+title: Installing league/iso3166
 ---
 
-# Installing
+# Installing league/iso3166
 
 ```
 composer require league/iso3166

diff --git a/docs/using.md b/docs/using.md
@@ -0,0 +1,29 @@
+---
+layout: default
+permalink: /using
+title: Using league/iso3166
+---
+
+# Using league/iso3166
+
+## Interface
+
+The following methods are provided by the `League\ISO3166\DataProvider` interface.
+
+**Lookup data by alpha2 code:**
+
+``` php
+$data = (new League\ISO3166\ISO3166)->alpha2($alpha2);
+```
+
+**Lookup data by alpha3 code:**
+
+``` php
+$data = (new League\ISO3166\ISO3166)->alpha3($alpha3);
+```
+
+**Lookup data by numeric code:**
+
+``` php
+$data = (new League\ISO3166\ISO3166)->numeric($numeric);
+```