Added readme

README.md

@@ -0,0 +1,64 @@
+# ticker
+
+Terminal stock watcher and stock position tracker
+
+## Features
+
+* Watch stock price quotes
+* Track value of stock positions and update with price quote updates
+* Support for multiple cost basis lots
+
+## Install
+
+Download the pre-compiled binaries from the [releases page](https://github.com/achannarasappa/ticker/releases) and copy to a location in `PATH` or see quick installs below
+
+**mac**
+```
+brew install achannarasappa/tap/ticker
+```
+
+**linux**
+```sh
+curl -Ls https://api.github.com/repos/achannarasappa/ticker/releases/latest \
+| grep -wo "https.*linux-amd64*.tar.gz" \
+| wget -qi - \
+&& tar -xf ticker*.tar.gz \
+&& chmod +x ./ticker \
+&& sudo mv ticker /usr/local/bin/
+```
+
+## Quick Start
+
+```sh
+ticker -w NET,AAPL,TSLA
+```
+
+## Usage
+|Alias|Flag|Default|Description|
+|-|-|-|-|
+|   |--config|`~/.ticker.yaml`|config with watchlist and positions|
+|-i,|--interval|`5`|Refresh interval in seconds|
+|-w,|--watchlist||comma separated list of symbols to watch|
+
+## Configuration
+
+Configuration is not required to watch stock price but is helpful when always watching the same stocks. Configuration can also be used to set cost basis lots which will in turn be used to show daily gain or loss on any position.
+
+```yaml
+# ~/.ticker.yaml
+watchlist:
+  - NET
+  - TEAM
+  - ESTC
+  - BTC-USD
+lots:
+  - symbol: "ABNB"
+    quantity: 35.0
+    unit_cost: 146.00
+  - symbol: "ARKW"
+    quantity: 20.0
+    unit_cost: 152.25
+  - symbol: "ARKW"
+    quantity: 20.0
+    unit_cost: 145.35
+```