Merge pull request #23 from saitei/develop

Merge Develop to Master for 1.0

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Crypto Sheets Contribution Guidelines
+
+This script is aimed at being user friendly, with the eventual goal of users not having to edit the script at all.  Please check the open issues and add new ones for additional features or bugs.
+
+## This project utilizes GitFlow
+
+Please create new feature branches for new functionality.  These branches will then be merged into the `develop` branch for further testing and review until packaged into a new `release` and merged back into `master`.
+
+For general GitFlow guidelines and best practices, please consult [Atlassian's GitFlow Tutorial](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
+
+## Chat with other devs
+
+I have created a gitter community at https://gitter.im/cryptosheets/development
+
+## Reddit
+
+Please promote the use of our subreddit for user help.  If you're a contributor to the project, feel free to request moderator privileges.  Users should also be encouraged to create GitHub issues, or create issues based on commonly seen issues.
+
+https://www.reddit.com/r/cryptosheets/
+
+## License
+
+This project is licensed under the GNU General Public License v3.0

README.md

@@ -1,36 +1,127 @@
 # Crypto Sheets
-Google Sheets script editor code for managing a cryptocurrency tracking spreadsheet
 
-## Instructions
+This is a (javascript-based) tool to aid in creating your own crypto tracking spreadsheet.  It can automagically pull in current cryptocurrency rates, as well as your wallet balances.  It requires the use of Google Sheets and its built-in script editor.
 
-This is a template for creating your own spreadsheet to track your cryptocurrency balances and current prices.  It assumes the use of Google Sheets and the built in script editor (Tools > Script editor...).
+If you want a better understanding of how it works and have no programming experience, it's never too late to learn.  Take a free course at **Codecademy** and flex your brain :muscle::fireworks:.  [Programming can open doors for you, no matter your occupation](https://www.forbes.com/sites/laurencebradford/2016/06/20/why-every-millennial-should-learn-some-code/#1231c1e270f2).
+https://www.codecademy.com/learn/introduction-to-javascript
+
+# Instructions
+
+## Populating `Rates` sheet with currency data
+
+1. Create [a new Google Sheets spreadsheet](docs.google.com/spreadsheets) and name it something, or open an existing one
+
+    1. ![Create new spreadsheet](https://i.imgur.com/ARb3B0Dm.png)
+
+    1. ![Name your spreadsheet](https://i.imgur.com/uJ6h43nm.png)
+
+1. Create two new sheets called `Rates` and `Wallets`
+
+    1. ![Rates and Wallets sheets](https://i.imgur.com/WHO747jm.png)
+
+1. Click "Tools > Script editor..." on the menu bar, and name your script project something
+
+    1. ![Script Editor](https://i.imgur.com/hjhZlaAm.png)
+
+    1. ![Project Name](https://i.imgur.com/tUXLp1Pm.png)
+
+1. Select all of the text in the right-side pane and delete it
+
+    1. ![Delete existing code](https://i.imgur.com/RVyXaUzm.png)
+
+1. Paste [the contents of scripteditor.js](scripteditor.js) into the right-side pane
+
+    1. ![Paste script](https://i.imgur.com/5ktIBNom.png)
 
-1. Click "Tools > Script editor..." on the menu bar
-1. Select all of the text in the right pane and delete it (unless you have already written your own functions)
-1. Paste the contents of scripteditor.js into the pane on the right
 1. Add in as many currencies that you want to track
-1. Add triggers "Edit > Current project's triggers..."
-   1. Click "Add a new trigger"
+
+    1. ![Add currencies to track](https://i.imgur.com/SyBS19j.png)
+
+1. Add triggers to your project ("Edit > Current project's triggers...").  This is how your spreadsheet will update automatically.
+
+   1. ![Add triggers](https://i.imgur.com/d7MIO7Km.png)
+
+   1. Set up a new trigger
+
+     1. ![New trigger](https://i.imgur.com/AzDXGQvm.png)
+
    1. In the "Run" dropdown, choose "getData" and choose which triggers you'd like.  I use "Time-driven/Minutes/Every 15", and "From spreadsheet/On open".
+
+     1. ![Trigger definition](https://i.imgur.com/SyEoEVv.png)
+
+You can manually execute the script to test it by clicking the `Select function`, selecting `getData`, and clicking the run button (looks like the play symbol)
+
+  ![Manually execute script](https://i.imgur.com/TP5BMTAm.png)
+
+## Populating `Wallets` sheet with account balances
+*Note: Currently only supports BCH, BTC, ETH, and VTC.  Update other wallet balances manually in your spreadsheet for the time being.  Feel free to [submit an issue](https://github.com/saitei/crypto-sheets/issues) for other currencies.*
+
+1. Make sure you have created a `Wallets` sheet
+
+   1. ![Rates and Wallets sheets](https://i.imgur.com/WHO747jm.png)
+
+1. In the script editor, uncomment (delete the `//` before) `var ssWallets = ss.getSheetByName('Wallets')`
+
+   1. ![uncomment wallets sheet](https://i.imgur.com/RUysbr9m.png)
+
+   1. It should look like this
+
+     1. ![uncommented code](https://i.imgur.com/iPO8UIlm.png)
+
+1. Scroll down to the `WALLET BALANCE CONFIGURATION` section (around line 130)
+
+   1. ![wallet section](https://i.imgur.com/0ODMumfm.png)
+
+1. Follow the instructions for each currency to add your address.  You can change the value in `getRange` to output the balance to a different cell in the `Wallets` sheet.
+   1. Before configuration
+
+     1. ![before wallet config](https://i.imgur.com/iZkSemq.png)
+
+   1. After configuration
+
+     1. ![after wallet config](https://i.imgur.com/dTLu4cC.png)
+
+
+## Advanced
+
+There are comments in the code for anything that's not covered here.  If you had to use these instructions, the safe bet is to not modify anything else.
+
+## How to Contribute
+
+* Help others in the cryptosheets subreddit (https://www.reddit.com/r/cryptosheets/).  You don't need to write any code to help others out.
+* Hop in the gitter.im chat rooms
+   * [Lobby](https://gitter.im/cryptosheets/Lobby)
+   * [Development](https://gitter.im/cryptosheets/development)
+* Check out the [contributing page](CONTRIBUTING.md) and become involved on GitHub
+* If all else fails, give a stranger a compliment and brighten their day
 
-There are comments in the code, and I'll add better instructions here in the future.
+### Powered By
 
-*More instructions to follow.
+[CoinMarketCap](https://coinmarketcap.com/)
+[Block Explorer](https://blockexplorer.com)
+[Etherscan](https://etherscan.io)
+explorer.vertcoin.info
 
-## To Do
+### Acknowledgements
 
-1. Add detailed instructions for configuring your own Google Sheets crypto tracker
-1. Templatize the script to pull in lists of cryptos to track, and account balances to track
-1. Historical data
+apiontek
+iKrazy
+solifugo
+yukihirai0505
+Christopher Walken
 
-## Donations
+### Donations
 
-They are appreciated but not expected
 
-* XRB - xrb_3ix8dfgn7hkz3choqi1qr6jgopoodh1jr1giwixzqaohks7d1f98dau45c11
-* ETH - 0x7E9DDB5343a583705Ed9ADE065C0595EFB55D681
-* VTC - Vo8EXgAtxCVUtMaTQECuzLD2tZU1HqLbhT
+* XRB
+   * **xrb_3ix8dfgn7hkz3choqi1qr6jgopoodh1jr1giwixzqaohks7d1f98dau45c11**
+* ETH
+   * **0x7E9DDB5343a583705Ed9ADE065C0595EFB55D681**
+* VTC
+   * **Vo8EXgAtxCVUtMaTQECuzLD2tZU1HqLbhT**
+* BCH
+   * **1Gzs8uKoUY23R7kTRE8NwAucAArAk8mdCg**
 
-## License
+### License
 
 This project is licensed under the GNU General Public License v3.0