summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJared Norman <jared@super.gd>2018-12-30 15:53:31 -0800
committerJared Norman <jared@super.gd>2018-12-30 16:11:29 -0800
commitbe044a6bbc2bca4f36d6f94968602cb148659e6c (patch)
tree456c8582debebcfbe87442e61c63b38ede7117d0 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e55792c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# SuperGood::SolidusTaxjar
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'super_good-solidus_taxjar'
+```
+
+And then execute:
+
+ $ bundle
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SuperGoodSoft/solidus_taxjar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SuperGood::SolidusTaxjar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SuperGoodSoft/solidus_taxjar/blob/master/CODE_OF_CONDUCT.md).