Add usage section on README

README.md

@@ -0,0 +1,62 @@
+# Dependency Calculator
+
+
+## Introduction
+- This is the demonsration for SITCON 2019 talk.
+
+## Usage
+Here is some examples about how to calculate two numbers.
+
+### Add two numbers
+```php
+use Lee\Calculator\Calculator;
+use Lee\Calculator\modules\GmpCalculator;
+use Lee\Calculator\modules\BcMathCalculator;
+
+$gmpCalculator = new Calculator(new GmpCalculator());
+$bcMathCalculator = new Calculator(new BcMathCalculator());
+
+echo $gmpCalculator->add('123456789', '123456789000000'); // 123456912456789
+echo $bcMathCalculator->add('123456789', '123456789000000'); // 123456912456789
+```
+
+### Minus two numbers
+```php
+use Lee\Calculator\Calculator;
+use Lee\Calculator\modules\GmpCalculator;
+use Lee\Calculator\modules\BcMathCalculator;
+
+$gmpCalculator = new Calculator(new GmpCalculator());
+$bcMathCalculator = new Calculator(new BcMathCalculator());
+
+echo $gmpCalculator->minus('123456789', '123456789000000'); // -123456665543211
+echo $bcMathCalculator->minus('123456789', '123456789000000'); // -123456665543211
+```
+
+### Multiple two numbers
+```php
+
+use Lee\Calculator\Calculator;
+use Lee\Calculator\modules\GmpCalculator;
+use Lee\Calculator\modules\BcMathCalculator;
+
+$gmpCalculator = new Calculator(new GmpCalculator());
+$bcMathCalculator = new Calculator(new BcMathCalculator());
+
+echo $gmpCalculator->mul('123456789', '123456789000000'); // 15241578750190521000000
+echo $bcMathCalculator->mul('123456789', '123456789000000'); // 15241578750190521000000
+```
+
+### Divide two numbers
+```php
+
+use Lee\Calculator\Calculator;
+use Lee\Calculator\modules\GmpCalculator;
+use Lee\Calculator\modules\BcMathCalculator;
+
+$gmpCalculator = new Calculator(new GmpCalculator());
+$bcMathCalculator = new Calculator(new BcMathCalculator());
+
+echo $gmpCalculator->divide('123456789000000', '123456789'); // 1000000
+echo $bcMathCalculator->divide('123456789000000', '123456789'); // 1000000
+```

src/Calculator.php

@@ -2,7 +2,7 @@
 
 namespace Lee\Calculator;
 
-use Lee\Calculator\interfaces\CalculatorInterface;
+use Lee\Calculator\interfaces\Calculator as CalculatorInterface;
 
 class Calculator
 {

src/interfaces/CalculatorInterface.php → src/interfaces/Calculator.php

@@ -2,7 +2,7 @@
 
 namespace Lee\Calculator\interfaces;
 
-interface CalculatorInterface
+interface Calculator
 {
     public function add(string $num1, string $num2): string;
     public function minus(string $num1, string $num2): string;

src/modules/BcMathCalculator.php

@@ -2,9 +2,9 @@
 
 namespace Lee\Calculator\modules;
 
-use Lee\Calculator\interfaces\CalculatorInterface;
+use Lee\Calculator\interfaces\Calculator;
 
-class BcMathCalculator implements CalculatorInterface
+class BcMathCalculator implements Calculator
 {
     public function add(string $num1, string $num2): string
     {
@@ -30,7 +30,7 @@ public function mul(string $num1, string $num2): string
     public function divide(string $num1, string $num2): string
     {
         if ((int)$num2 === 0) {
-            throw \InvalidArgumentException('The zero operand not allowed!');
+            throw new \InvalidArgumentException('The zero operand not allowed!');
         }
 
         return \bcdiv($num1, $num2);

src/modules/GmpCalculator.php

@@ -2,9 +2,9 @@
 
 namespace Lee\Calculator\modules;
 
-use Lee\Calculator\interfaces\CalculatorInterface;
+use Lee\Calculator\interfaces\Calculator;
 
-class GmpCalculator implements CalculatorInterface
+class GmpCalculator implements Calculator
 {
     public function add(string $num1, string $num2): string
     {
@@ -30,7 +30,7 @@ public function mul(string $num1, string $num2): string
     public function divide(string $num1, string $num2): string
     {
         if ((int)$num2 === 0) {
-            throw \InvalidArgumentException('The zero operand not allowed!');
+            throw new \InvalidArgumentException('The zero operand not allowed!');
         }
 
         return \gmp_div($num1, $num2);