aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruce Wells <brucekwells@gmail.com>2019-01-12 07:48:43 +0300
committerBruce Wells <brucekwells@gmail.com>2019-01-12 07:56:39 +0300
commit44e2bb192eb1c847741894ef24c8fbe24fe2f15a (patch)
treecaac62a21a43b80221121f3838b8cd5487d27983 /README.md
parent145a0a136fc41dc59a78637a8e84f1c8952ecc31 (diff)
Fixed function parameter order
Corrected $places default value for addFunction to match TokenFactory Added function order test and put expected order first in assertEquals If else blocks in calculator Updated docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.md b/README.md
index b86f9c6..81d9475 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# MathExecutor [![Stories in Ready](https://badge.waffle.io/NeonXP/MathExecutor.png?label=ready&title=Ready)](https://waffle.io/NeonXP/MathExecutor) [![Build Status](https://travis-ci.org/NeonXP/MathExecutor.png?branch=master)](https://travis-ci.org/NeonXP/MathExecutor)
-A simple math expressions calculator
+# A simple and extensible math expressions calculator
## Features:
* Built in support for +, -, *, / and power (^) operators plus ()
@@ -11,7 +11,7 @@ A simple math expressions calculator
* Exceptions on divide by zero, or treat as zero
* Unary Minus (e.g. -3)
* Pi ($pi) and Euler's number ($e) support to 11 decimal places
-* Easily extendable
+* Easily extensible
## Install via Composer:
```
@@ -41,10 +41,9 @@ Default functions:
Add custom function to executor:
```php
-$executor->addFunction('abs', function($arg) {
- return abs($arg);
-}, 1);
+$executor->addFunction('abs', function($arg) {return abs($arg);});
```
+Function default parameters are not supported at this time.
## Operators:
Default operators: `+ - * / ^`