SpreeStoreCredits
=================

Introduction goes here.

Installation
------------

Add spree_store_credits to your Gemfile:

```ruby
gem 'spree_store_credits'
```

Bundle your dependencies and run the installation generator:

```shell
bundle
bundle exec rails g spree_store_credits:install
```

Testing
-------

First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.

```shell
bundle
bundle exec rake
```

When testing your applications integration with this extension you may use it's factories.
Simply add this require statement to your spec_helper:

```ruby
require 'spree_store_credits/factories'
```

Copyright (c) 2014 [Bonobos], released under the New BSD License

SpreeStoreCredits
=================

A Spree store credit implementation that applies store credit as a payment method.

Takes into account purchasing through the API, with the default to use all available store credit.

Store credit can be granted in admin, and is frozen after first usage. Store credit behaves like a credit card in that once an amount is authorized, it cannot be used elsewhere.

Store credit can be stored in multiple buckets (e.g. promotional and refund) because those are taxed differently and implementors might want to prioritize use / refund different types.

Installation
------------

Add spree_store_credits to your Gemfile:

```ruby
gem 'spree_store_credits'
```

Bundle your dependencies and run the installation generator:

```shell
bundle
bundle exec rails g spree_store_credits:install
```

Testing
-------

First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.

```shell
bundle
bundle exec rake
```

When testing your applications integration with this extension you may use it's factories.
Simply add this require statement to your spec_helper:

```ruby
require 'spree_store_credits/factories'
```

TODO
----

* Integrate the frontend, this was implemented with just admin and api

Copyright (c) 2014 [Bonobos], released under the New BSD License

Update readme to explain some of the choices made and TODO
Update readme to explain some of the choices made and TODO
