Skip to content

Commit

Permalink
update README info
Browse files Browse the repository at this point in the history
  • Loading branch information
Yorchi committed Mar 15, 2018
1 parent 17d0345 commit f47633b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 22 deletions.
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Very short description of the package

[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
[![Build Status](https://img.shields.io/travis/spatie/:package_name/master.svg?style=flat-square)](https://travis-ci.org/spatie/:package_name)
[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/:package_name)
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)

**Note:** Replace ```:author_name``` ```:author_username``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
[![Latest Version on Packagist](https://img.shields.io/packagist/v/feimx/Tax.svg?style=flat-square)](https://packagist.org/packages/feimx/Tax)
[![Build Status](https://img.shields.io/travis/feimx/Tax/master.svg?style=flat-square)](https://travis-ci.org/feimx/Tax)
[![Quality Score](https://img.shields.io/scrutinizer/g/feimx/Tax.svg?style=flat-square)](https://scrutinizer-ci.com/g/feimx/Tax)
[![Total Downloads](https://img.shields.io/packagist/dt/feimx/Tax.svg?style=flat-square)](https://packagist.org/packages/feimx/Tax)

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Expand All @@ -14,14 +12,15 @@ This is where your description should go. Try and limit it to a paragraph or two
You can install the package via composer:

```bash
composer require spatie/:package_name
composer require feimx/Tax
```

## Usage

``` php
$skeleton = new Spatie\Skeleton();
echo $skeleton->echoPhrase('Hello, Spatie!');
$taxManager = new FeiMx\Tax\TaxManager($amount = 100);
$taxManager->addTax('iva');
echo $taxManager->get(); // 116.000000
```

### Testing
Expand All @@ -40,26 +39,19 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

## Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
If you discover any security related issues, please email yorch@fei.com.mx instead of using the issue tracker.

We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).

## Credits

- [:author_name](https://github.com/:author_username)
- [Jorge Andrade](https://github.com/Yorchi)
- [All Contributors](../../contributors)

## Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
FEI is a Digital Invoicing startup based in Yucatán, México. You'll find an overview of all our open source projects [on our website](https://fei.com.mx/opensource).

Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/spatie).
Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/jorge_andrade).
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

## License
Expand Down
2 changes: 0 additions & 2 deletions tests/TaxManagerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ public function testCanCalculateISR()

public function testCanCalculateMultipleTaxes()
{
// 2300.90 + (2300.90*.16) + (2300.90*-0.106667)
$taxManager = new TaxManager(100);
$taxManager->addTax('iva');
$taxManager->addTax('isr');
Expand All @@ -185,7 +184,6 @@ public function testCanCalculateMultipleTaxes()
$taxManager->addTax('isr');
$this->assertEquals(2423.613900, $taxManager->get());

// 2300.90 + (2300.90*.16) + (2300.90*-0.106667) + (2300.90*0.08)
$taxManager = new TaxManager(100);
$taxManager->addTax('iva');
$taxManager->addTax('isr');
Expand Down

0 comments on commit f47633b

Please sign in to comment.