From 048bba801de6dd2e6a05e6acff607c211324a2e8 Mon Sep 17 00:00:00 2001 From: scoobybejesus <21372487+scoobybejesus@users.noreply.github.com> Date: Mon, 26 Aug 2019 14:08:00 -0400 Subject: [PATCH] Provided clarity on the code's purpose --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5e482b..d26bb4c 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ ### Accounting library for cryptocurrency transaction activity. -It provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used). -Reports may be exported as CSV files that reflect income/expense/gains/losses. +The software provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used). +Given a CSV file reflecting the user's entire cryptocurrency transaction history, the software will process that activity in a way that assigns cost basis at the date of purchase/exchange/receipt, preserves the character (date purchased and cost basis, most notably) of all holdings up until the time they are disposed, and when holdings are disposed the gain or loss from sale/exchange/disposal will be computed (including whether the gain or loss is short-term or long-term). +Reports that reflect income/expense/gains/losses may be exported as CSV files, and the user can supply the desired relative or absolute path for where the reports are saved. -The activity that gets imported **must** be in a prescribed form that effectively looks like this: +The activity that gets imported **must** be in a prescribed form (a CSV file) that effectively looks like this: |txDate |proceeds|memo |1 |2 |3 |4 |5 | @@ -24,8 +25,9 @@ The activity that gets imported **must** be in a prescribed form that effectivel |9/1/16 |400 |NINTH | |-0.5 | |200 | | |10/1/16|900 |TENTH | |1 | |-200 | | |11/1/16|0 |ELEVENTH| |-1.5 |1.5 | | | -|12/1/16|2000 |TWELFTH | | |-1.5 | |400 | +|12/1/16|2000 |TWELFTH*| | |-1.5 | |400 | +\* this last transaction is an example of how a user might reflect an exchange via Shapeshift or similar services, where one currency is spent from one wallet and a different currency is received in another wallet. #### CSV file components