ldgr 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +34 -5
- data/lib/ldgr/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1cdd71b68327e76f3c01194a9a24e5e2c053b310
|
|
4
|
+
data.tar.gz: 55fb61cbb6400393d965e131165934c015d64d10
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2ca3cc59260eb2b85bf97a9a14a9213320c3f66994fb64b1e8b486f264dd9e616d190e2b7827f1ea124c9dac88ccce5215dbe4d0754a2011dce52a51ea2cd570
|
|
7
|
+
data.tar.gz: e646c0f9cdc2505bd5300b0eccbc4fdc835e83291caa6a04dd897d289a6e196be715315bc5c779614f8ca17f605a4bb6f84188894646defd4aa47d1da4a0b2e2
|
data/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# Ldgr
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
|
3
|
+
Ldgr is a command-line tool for adding, sorting and tagging transactions in your Ledger file.
|
|
6
4
|
|
|
7
5
|
## Installation
|
|
8
6
|
|
|
@@ -22,7 +20,38 @@ Or install it yourself as:
|
|
|
22
20
|
|
|
23
21
|
## Usage
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
Type `ldgr -h` at the command-line to see available commands and options.
|
|
24
|
+
|
|
25
|
+
## CLI
|
|
26
|
+
```sh
|
|
27
|
+
ldgr add --payee Brandon \
|
|
28
|
+
--amount 1000 \
|
|
29
|
+
--account Something \
|
|
30
|
+
--equity Cash \
|
|
31
|
+
--date 2017-02-01 \
|
|
32
|
+
--effective 2017-02-03 \
|
|
33
|
+
--cleared`
|
|
34
|
+
ldgr clear
|
|
35
|
+
ldgr sort
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Library
|
|
39
|
+
|
|
40
|
+
~~~ruby
|
|
41
|
+
transaction = Ldgr::Transaction.new do |t|
|
|
42
|
+
t.payee = 'Brandon'
|
|
43
|
+
t.amount = 1000
|
|
44
|
+
t.account = 'Something'
|
|
45
|
+
t.equity = 'Cash
|
|
46
|
+
t.date = Date.today + 1'
|
|
47
|
+
t.effective = Date.today + 10'
|
|
48
|
+
t.cleared = true
|
|
49
|
+
end
|
|
50
|
+
~~~
|
|
51
|
+
|
|
52
|
+
## TODO
|
|
53
|
+
|
|
54
|
+
Currently, the Ledger file is a constant set to `~/.config/ledger/transactions.dat`. This should probably be customizable, possibly with a `.ldgrrc` in the future. Also, the default currency is Japanese Yen. You can change this the `--currency $` flag on the command line or setting it in the `Transaction.new` block. In the future, this should be set in an rc file.
|
|
26
55
|
|
|
27
56
|
## Development
|
|
28
57
|
|
|
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
|
32
61
|
|
|
33
62
|
## Contributing
|
|
34
63
|
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
64
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/brandonpittman/ldgr. 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.
|
|
36
65
|
|
|
37
66
|
|
|
38
67
|
## License
|
data/lib/ldgr/version.rb
CHANGED