diff options
| author | Jared Norman <jared@super.gd> | 2019-06-30 13:15:57 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-30 13:15:57 -0700 |
| commit | 3d0f3290895d1ced737a4068202bb015b660ec46 (patch) | |
| tree | add69a8181f1f2b7a3693a3a98610d1405cb0e27 | |
| parent | b0dee58db6bfe9fba377b12c86dd09e9d68d9fca (diff) | |
Downgrade warning
This is ready for primetime use, but missing documentation and some other things I want to include in v1.0.
| -rw-r--r-- | README.md | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -1,5 +1,3 @@ -## *Warning:* This extension is under active development and not yet at a v1.0 release. - # `SuperGood::SolidusTaxJar` [](https://travis-ci.com/SuperGoodSoft/solidus_taxjar) `SuperGood::SolidusTaxJar` is a [Solidus](https://github.com/solidusio/solidus) extension that allows Solidus stores to use [TaxJar](https://www.taxjar.com/) for tax calculations. @@ -42,6 +40,14 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr 4. Finally, make sure that the `TAXJAR_API_KEY` environment variable is set to a your TaxJar API key and make sure that you have a `Spree::TaxRate` with the name "Sales Tax". This will be used as the source for the tax adjustments that Solidus creates. +## Project Status + +This extension is under active development and not yet at a v1.0 release, but it's currently being used in production by multiple Solidus stores. + +Requirements for TaxJar integrations vary as some stores also need reporting, which isn't provided out of the box by this extension. This is because individual stores will be using different background job frameworks or runners (Sidekiq, delayed_job, ActiveJob, etc.) and a reliable integration will rely on one of these. Because this part of the integration is small, we've chosen to provide the transaction reporting functionality, but have skipped directly integrating it. + +If you're having trouble integrating this extension with your store and would like some assistance, please reach out to Jared via e-mail at [jared@super.gd](mailto:jared@super.gd) or on the official Solidus as `@jared`. + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. |