Skip to content

Commit baa7864

Browse files
authored
Update the README (#3)
1 parent d72bec0 commit baa7864

File tree

4 files changed

+72
-53
lines changed

4 files changed

+72
-53
lines changed

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
ofx (0.4.0)
4+
ofx (0.4.1)
55
nokogiri (~> 1.14.5)
66

77
GEM

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# OFX
2+
3+
[![Gem Version](https://badge.fury.io/rb/ofx.svg)](https://badge.fury.io/rb/ofx)
4+
[![Build Status](https://github.com/annacruz/ofx/actions/workflows/config.yml/badge.svg)](https://github.com/annacruz/ofx/actions)
5+
6+
A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports both OFX 1.0.2 and 2.1.1.
7+
8+
## Usage
9+
10+
```ruby
11+
require "ofx"
12+
13+
OFX("file.ofx") do
14+
p account
15+
p account.balance
16+
p account.transactions
17+
end
18+
```
19+
20+
Invalid files will raise an OFX::UnsupportedFileError.
21+
22+
23+
## Deploy
24+
25+
### New version
26+
27+
1. New version at `lib/ofx/version.rb`;
28+
2. Execute `$ bundle`;
29+
3. Commit and push to Github;
30+
31+
### Release at Github
32+
33+
1. Create a [new release on Github](https://github.com/asseinfo/ofx/releases/new)
34+
1. Fill the **the new tag**. Ex.: v4.0.1
35+
1. Target `master`
36+
1. Fill the **Release title**. Ex.: 4.0.1 (March 3, 2020)
37+
1. Click at **Generate release notes**
38+
1. Click at **Publish release**
39+
40+
[Reference here](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository)
41+
42+
## Creator
43+
44+
* Nando Vieira - http://simplesideias.com.br
45+
46+
## Maintainer
47+
48+
* Anna Cruz - http://anna-cruz.com
49+
50+
## License
51+
52+
(The MIT License)
53+
54+
Permission is hereby granted, free of charge, to any person obtaining a copy
55+
of this software and associated documentation files (the 'Software'), to deal
56+
in the Software without restriction, including without limitation the rights
57+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
58+
copies of the Software, and to permit persons to whom the Software is
59+
furnished to do so, subject to the following conditions:
60+
61+
The above copyright notice and this permission notice shall be included in all
62+
copies or substantial portions of the Software.
63+
64+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
65+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
66+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
67+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
68+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
69+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
70+
SOFTWARE.

README.rdoc

Lines changed: 0 additions & 51 deletions
This file was deleted.

lib/ofx/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module OFX
2-
VERSION = '0.4.0'.freeze
2+
VERSION = '0.4.1'.freeze
33
end

0 commit comments

Comments
 (0)