README.md
# Taxplorer
[![Gem Version](https://badge.fury.io/rb/taxplorer.svg)](http://badge.fury.io/rb/taxplorer)
[![Build Status](https://travis-ci.org/seocahill/taxplorer.svg?branch=master)](https://travis-ci.org/seocahill/taxplorer)
[![Code Climate](https://codeclimate.com/github/seocahill/taxplorer/badges/gpa.svg)](https://codeclimate.com/github/seocahill/taxplorer)
[![Test Coverage](https://codeclimate.com/github/seocahill/taxplorer/badges/coverage.svg)](https://codeclimate.com/github/seocahill/taxplorer/coverage)
Taxplorer is a command line tool to view the content of XBRL taxonomy Schemas.
At the moment only UK GAAP / IFRS is supported
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'taxplorer'
```
And then execute:
$ taxplorer
Or install it yourself as:
$ gem install taxplorer
## Usage
![Taxplorer gif](https://s3.eu-central-1.amazonaws.com/gen-images/taxplorer.gif)
## Contributing
1. Fork it ( https://github.com/[my-github-username]/taxplorer/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request