decent 0.2.3 → 0.2.4

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +76 -59
  3. data/lib/decent/version.rb +1 -1
  4. data/lib/decent.rb +1 -1
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9c28304a031987d93bbfa0153aa1267e7decb616
4
- data.tar.gz: 130faa5b59c16eaaa01a635c5e46620bf292b8a9
3
+ metadata.gz: 7efd472f68f75063e091ed0d58de811aadb9f833
4
+ data.tar.gz: 366ebead67839e6ed8e2b3c428f2f6a3e3af1d49
5
5
  SHA512:
6
- metadata.gz: 4e0be7cb82a6789539cb047bed6925f516971456acc1ec87d644437d7cc17116e34389634aaf7490bc2c75857edf9582faaa921de13891552b4860f0dc2aa1e5
7
- data.tar.gz: bc450035307378ca5b04be2e6eb6603529ef95a8adf6976c2b56a3d34706dc56d710d307c7b51617ce932e71b3d6f2767efd6a59f3e31126fe48f39d97ea1004
6
+ metadata.gz: 79539b8d25c2aaa301516a79bbe97184add78b3134e210c5da5047f0de716b70b7757d494a61e843c21d3efbd03ddd284d768adf5567a7b8b650e264d625e5bd
7
+ data.tar.gz: 3418cb8c55fa6ba115dbfeeedceed2c1e141be39242b752131962c911096c75ee66b2ae3fb09496c98f3d07fc4bf33cec93580614edd4bfd15aaff879dac2255
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # decent
2
2
 
3
- A Ruby command line application for managing cryptocurrency holdings.
3
+ A command line application for managing cryptocurrency holdings.
4
4
 
5
5
  ## Synopsis
6
6
 
@@ -16,12 +16,84 @@ Currently (as of 0.1.3) supports Bitcoin (BTC), Ethereum (ETH), and Litecoin (LT
16
16
 
17
17
  ## Install
18
18
 
19
- `gem install decent`
19
+ ```sh
20
+ $ gem install decent
21
+ ```
22
+
23
+ ## Quickstart
24
+
25
+ ```sh
26
+ $ decent
27
+ ```
20
28
 
21
29
  ![HODL](http://imgh.us/screenshot_77.png)
22
30
 
23
- **Note: The first time `decent` runs, it will create a SQLite3 database in your home
24
- directory like so: `~/.decent/decent.db`**
31
+ Note: The first time `decent` runs, it will create a SQLite3 database in your home
32
+ directory like so: `~/.decent/decent.db`
33
+
34
+ ## Commands
35
+
36
+ ### Update Exchange Rates
37
+
38
+ ```sh
39
+ $ decent exchange_rate update
40
+ ```
41
+
42
+ Current exchange rates for all currencies are pulled from Coinbase and stored with a timestamp.
43
+ The previous values are copied to the `historic_exchange_rates` table.
44
+
45
+ ### List Exchange Rates
46
+
47
+ ```sh
48
+ $ decent exchange_rate list
49
+ ```
50
+
51
+ The most recently queried information for each exchange rate will be listed.
52
+
53
+ ### Add Hodling
54
+
55
+ ```sh
56
+ $ decent hodling add
57
+ ```
58
+
59
+ Creates a prompt asking for a nickname, address, and currency for a new hodling.
60
+
61
+ ### Update Hodlings
62
+
63
+ ```sh
64
+ $ decent hodling update
65
+ ```
66
+
67
+ Current balances for all locally stored address are pulled from APIs and stored with a timestamp.
68
+ The previous values are copied to the `historic_holdings` table.
69
+
70
+ ### List Hodlings
71
+
72
+ ```sh
73
+ decent hodling list
74
+ ```
75
+
76
+ The most recently queried information for each locally stored hodling will be listed.
77
+
78
+ ### Show Hodling
79
+
80
+ ```sh
81
+ $ decent hodling show -nickname NICKNAME
82
+ ```
83
+
84
+ The most recently queried information for the hodling with nickname NICKNAME will be displayed,
85
+ along with its value in USD based on the most recently queried exchange_rate for its respective
86
+ currency.
87
+
88
+ ### Remove Hodling
89
+
90
+ ```sh
91
+ $ decent hodling remove -nickname NICKNAME
92
+ ```
93
+
94
+ The most recently queried information for the hodling with nickname NICKNAME will be removed, and
95
+ that hodling will no longer appear in the `holdings` table. Related entries in the
96
+ `historic_holdings` table will not be affected.
25
97
 
26
98
  ## Schema
27
99
 
@@ -68,61 +140,6 @@ decent uses SQLite3.
68
140
  `created_at` timestamp
69
141
  ```
70
142
 
71
- ## Commands
72
-
73
- ### Update Exchange Rates
74
-
75
- **Command:** `decent exchange_rate update`
76
-
77
- **Result:** Current exchange rates for all currencies are pulled from Coinbase and
78
- stored with a timestamp. The previous values are copied to the `historic_exchange_rates`
79
- table.
80
-
81
- ### List Exchange Rates
82
-
83
- **Command:** `decent exchange_rate list`
84
-
85
- **Result:** The most recently queried information for each exchange rate will be
86
- listed.
87
-
88
- ### Add Hodling
89
-
90
- **Command:** `decent hodling add`
91
-
92
- **Result:** Creates a prompt asking for a nickname, address, and currency for a new
93
- hodling.
94
-
95
- ### Update Hodlings
96
-
97
- **Command:** `decent hodling update`
98
-
99
- **Result:** Current balances for all locally stored address are pulled from the APIs
100
- and stored with a timestamp. The previous values are copied to the `historic_holdings`
101
- table.
102
-
103
- ### List Hodlings
104
-
105
- **Command:** `decent hodling list`
106
-
107
- **Result:** The most recently queried information for each locally stored hodling will
108
- be listed.
109
-
110
- ### Show Hodling
111
-
112
- **Command:** `decent hodling show -nickname NICKNAME`
113
-
114
- **Result:** The most recently queried information for the hodling with nickname NICKNAME
115
- will be displayed, along with its value in USD based on the most recently queried
116
- exchange rate for its respective currency.
117
-
118
- ### Remove Hodling
119
-
120
- **Command:** `decent hodling remove -nickname NICKNAME`
121
-
122
- **Result:** The most recently queried information for the hodling with nickname NICKNAME
123
- will be removed, and that hodling will no longer appear in the `holdings` table.
124
- Related entries in the `historic_holdings` table will not be affected.
125
-
126
143
  ## Donations
127
144
 
128
145
  I'm not expecting any of these, but here are my public addresses :)
data/lib/decent/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Decent
2
- VERSION = "0.2.3"
2
+ VERSION = "0.2.4"
3
3
  end
data/lib/decent.rb CHANGED
@@ -27,7 +27,7 @@ require "decent/api/api"
27
27
  module Decent
28
28
  # Initialization
29
29
  program :name, "decent"
30
- program :version, "0.2.3"
30
+ program :version, "0.2.4"
31
31
  program :description, "A ruby command line application for managing cryptocurrency holdings."
32
32
 
33
33
  # Commands
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: decent
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.2.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - moondog