Sha256: 79f84c6102d8351f178f6e56129c2b5a5ce709eb6bff63196997b28ceb1bfee1

Contents?: true

Size: 1.33 KB

Versions: 9

Compression:

Stored size: 1.33 KB

Contents

# Bankscrap::<%= module_name %>

[Bankscrap](https://github.com/bankscrap/bankscrap) adapter for <%= bank_name %>.

**TODO**: write a proper description for your adapter.


## Installation

Add this line to your application's Gemfile:

```ruby
gem '<%= gem_name %>'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install <%= gem_name %>

## Usage

### From terminal
#### Bank account balance

    $ bankscrap balance <%= module_name %> --credentials=user:YOUR_USER --password:YOUR_PASSWORD --any_other_credential:ANY_OTHER_CREDENTIAL


#### Transactions

    $ bankscrap transactions <%= module_name %> --credentials=user:YOUR_USER --password:YOUR_PASSWORD --any_other_credential:ANY_OTHER_CREDENTIAL

---

For more details on usage instructions please read [Bankscrap readme](https://github.com/bankscrap/bankscrap/#usage).

### From Ruby code

```ruby
require '<%= gem_name %>'
<%= bank_name.underscore %> = Bankscrap::<%= module_name %>::Bank.new(user: YOUR_USER, password: YOUR_PASSWORD, any_other_credential: ANY_OTHER_CREDENTIAL)
```


## Contributing

1. Fork it ( https://github.com/bankscrap/<%= gem_name %>/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

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
bankscrap-2.1.1 generators/templates/README.md.tt
bankscrap-2.1.0 generators/templates/README.md.tt
bankscrap-2.0.6 generators/templates/README.md.tt
bankscrap-2.0.5 generators/templates/README.md.tt
bankscrap-2.0.4 generators/templates/README.md.tt
bankscrap-2.0.3 generators/templates/README.md.tt
bankscrap-2.0.2 generators/templates/README.md.tt
bankscrap-2.0.1 generators/templates/README.md.tt
bankscrap-2.0.0 generators/templates/README.md.tt