Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattstrayer committed Jul 20, 2020
1 parent 3b9c766 commit c5238ad
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Django TaxTea

Django Tax App for SaaS.
Django App that calculates tax rates for SaaS products

Taxes are hard. That shouldn't stop you from building your dreams. TaxTea does the heavy lifting and tells you exactly what sales tax, if any, you need to be charging your customers.

Expand Down Expand Up @@ -76,8 +76,34 @@ Import the ZipCode model:

```python
from taxtea.models import ZipCode

# Get the ZipCode Object from the database
# If no object exists for this Zip Code, it will create one by
# fetching data from the USPS API and storing it in the database.
# At this point, there will be no `tax_rate` associated with it.

zip_code = ZipCode.get("90210")

# The `applicable_tax_rate` property is the workhorse of TaxTea.
# It will fetch & store a tax rate from the Avalara API and then
# use your tax nexuses to determine which tax rate is applicable.

tax_rate = zip_code.applicable_tax_rate
# Returns a Decimal object that will look like `0.0625`

# For convenience, there is a classmethod to convert to a percent.

percentage = ZipCode.tax_rate_to_percentage(tax_rate)
# Returns a Decimal object that will look like `6.25`

```

## Docs

Read the docs: [](https://www.djangotaxtea.com)



## Resources

TaxTea uses a list provided by taxjar to populate the states and their tax collection methods.
Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ Welcome to Django TaxTea's documentation!
=========================================


TaxTea is a Django App that calculates tax rates for SaaS products


Taxes are hard. That shouldn't stop you from building your dreams. TaxTea does the heavy lifting and tells you exactly what sales tax, if any, you need to be charging your customers.

.. note:: Currently only supporting US 🇺🇸


.. toctree::
:caption: Getting Started

Expand Down

0 comments on commit c5238ad

Please # to comment.