ldgr 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee16cbdc1fb5e552a788d70eff66c55a6583f34
-  data.tar.gz: 497b5ab7dc28b3bc8c15e0615af5fe7a2aa27834
+  metadata.gz: 1cdd71b68327e76f3c01194a9a24e5e2c053b310
+  data.tar.gz: 55fb61cbb6400393d965e131165934c015d64d10
 SHA512:
-  metadata.gz: 1f48fcb8df5a50017812d10f59ae110e5d8c15d4c8127a62365be7df02599ba194ac9f7f5847983006c667708d4406b90fddb080f2568670a2a661ff8d53b04c
-  data.tar.gz: e7d3ee64ad5fe0b0dd3b76ffacf695c59c165996915e626d0a362a95fe385baf1042fab12718141433fc5a5db67fe18b3ae035b647d2e6045fbf5893297aa332
+  metadata.gz: 2ca3cc59260eb2b85bf97a9a14a9213320c3f66994fb64b1e8b486f264dd9e616d190e2b7827f1ea124c9dac88ccce5215dbe4d0754a2011dce52a51ea2cd570
+  data.tar.gz: e646c0f9cdc2505bd5300b0eccbc4fdc835e83291caa6a04dd897d289a6e196be715315bc5c779614f8ca17f605a4bb6f84188894646defd4aa47d1da4a0b2e2

data/README.md

@@ -1,8 +1,6 @@
 # Ldgr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ldgr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ldgr is a command-line tool for adding, sorting and tagging transactions in your Ledger file.
 
 ## Installation
 
@@ -22,7 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Type `ldgr -h` at the command-line to see available commands and options.
+
+## CLI
+```sh
+ldgr add --payee Brandon \
+         --amount 1000 \
+         --account Something \
+         --equity Cash \
+         --date 2017-02-01 \
+         --effective 2017-02-03 \
+         --cleared`
+ldgr clear
+ldgr sort
+```
+
+## Library
+
+~~~ruby
+transaction = Ldgr::Transaction.new do |t|
+    t.payee = 'Brandon'
+    t.amount = 1000
+    t.account = 'Something'
+    t.equity = 'Cash
+    t.date = Date.today + 1'
+    t.effective = Date.today + 10'
+    t.cleared = true
+end
+~~~
+
+## TODO
+
+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.
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Brandon Pittman/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.
+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.
 
 
 ## License

data/lib/ldgr/version.rb

@@ -1,3 +1,3 @@
 module Ldgr
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldgr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brandon Pittman