Skip to content
This repository has been archived by the owner on Oct 24, 2018. It is now read-only.

Commit

Permalink
@ #1 | update README: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
hoatle committed Aug 18, 2016
1 parent bbf4ba0 commit 30a2e7e
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ universal tax calculator javascript library
Library Architecture
--------------------

It's desinged with plugin mechanisum and minimalist in mind. By default:
It's designed with plugin mechanism and minimalist in mind. By default:

```
const taxer = new Taxer();
Expand All @@ -20,7 +20,7 @@ taxer.calc(countryCode, income, options);
in which:

taxMiddlewareFn should be a function accept (income, options) and return taxResult.
Moroever, taxMiddlewareFn should have a required function property `supports` that returns a boolean value.
Moreover, taxMiddlewareFn should have a required function property `supports` that returns a boolean value.
If it's true, taxResult will be processed by that tax middleware.
The taxResult will be returned from the first supported tax middleware.
If no supported tax middleware, an Error will be thrown.
Expand Down Expand Up @@ -50,23 +50,23 @@ How to use

1. Configure

1.1. From the default taxer with built-in tax middles:
1.1. From the default taxer with built-in tax middles:

```
const taxer = defaultTaxer();
// add more custom tax middleware function
taxer.use(customTaxMiddlewareFn);
```
```
const taxer = defaultTaxer();
// add more custom tax middleware function
taxer.use(customTaxMiddlewareFn);
```

1.2. From scratch
1.2. From scratch

```
const taxer = new Taxer();
taxer.use(vnTax());
taxer.use(usaTax());
taxer.use(sgTax());
taxer.use(customTax());
```
```
const taxer = new Taxer();
taxer.use(vnTax());
taxer.use(usaTax());
taxer.use(sgTax());
taxer.use(customTax());
```

2. Use

Expand All @@ -85,7 +85,9 @@ Let's keep it as minimal and lightweight as possible.
How to contribute
-----------------

By writing custom tax plugins to create a good solid universal tax system through out the world.
By writing custom tax plugins to create a good solid universal tax system throughout the world.

Follow Teracy workflow: http://dev.teracy.org/docs/workflow.html


License
Expand Down

0 comments on commit 30a2e7e

Please sign in to comment.