feature(README): update readme with installation and todo list

README.md

@@ -5,3 +5,52 @@
 
 Zap is a free Lightning Network wallet focused on user experience and ease of use, with the overall goal of helping the cryptocurrency community scale Bitcoin and other cryptocurrencies.
 
+## Install
+
+* **Note: requires a node version >= 7 and an npm version >= 4.**
+* **If you have installation or compilation issues, please see file a Github issue**
+
+First, clone the repo via git:
+```bash
+git clone https://github.com/LN-Zap/zap-desktop.git
+```
+
+And then install dependencies with yarn and npm.
+
+```bash
+$ cd zap-desktop
+$ yarn && npm install
+```
+```bash
+$ cd zap-desktop/app
+$ yarn && npm install
+```
+
+## Current Todo List (Last updated August 15th)
+
+## Refactor
+- [ ] Move Node.js proxy to [ipcRenderer](https://electron.atom.io/docs/api/ipc-renderer/) (roasbeef recommendation)
+- [ ] Payments modal using selector
+- [ ] Invoices modal using selector
+- [ ] General refactor (I know this TODO sucks but the code is a bit sloppy still, still need to spend time refactoring)
+
+## Features
+- [ ] Configurable BTCD + LN node connection (do not assume/rely on localhost)
+- [ ] Error handling
+- [ ] List on-chain transactions
+- [ ] Websocket handling for transactions
+- [ ] Websocket handling for sendpayment
+- [ ] Channel notifications
+- [ ] Payment notifications
+- [ ] Transaction notifications
+- [ ] Generate newaddress for the wallet deposit
+- [ ] Litecoin UI
+- [ ] Settings route
+- [ ] describegraph UI to see current status of the Lightning Network
+
+## Design
+- [ ] Error handling
+- [ ] On-chain transactions list
+- [ ] Notifications
+- [ ] Litecoin UI (pick out a silver main color)
+- [ ] describegraph UI to see current status of the Lightning Network

package-lock.json

@@ -16327,8 +16327,7 @@
     "xtend": {
       "version": "4.0.1",
       "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz",
-      "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=",
-      "dev": true
+      "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68="
     },
     "y18n": {
       "version": "3.2.1",

test/reducers/__snapshots__/balance.spec.js.snap

@@ -1,5 +1,21 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`reducers balanceReducer should handle DECREMENT_COUNTER 1`] = `
+Object {
+  "balanceLoading": false,
+  "channelBalance": undefined,
+  "walletBalance": undefined,
+}
+`;
+
+exports[`reducers balanceReducer should handle INCREMENT_COUNTER 1`] = `
+Object {
+  "balanceLoading": true,
+  "channelBalance": null,
+  "walletBalance": null,
+}
+`;
+
 exports[`reducers balanceReducer should handle initial state 1`] = `
 Object {
   "balanceLoading": false,
@@ -7,3 +23,11 @@ Object {
   "walletBalance": null,
 }
 `;
+
+exports[`reducers balanceReducer should handle unknown action type 1`] = `
+Object {
+  "balanceLoading": false,
+  "channelBalance": null,
+  "walletBalance": null,
+}
+`;

test/reducers/__snapshots__/channels.spec.js.snap

@@ -0,0 +1,22 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`reducers channelsReducer should handle initial state 1`] = `
+Object {
+  "channel": null,
+  "channelForm": Object {
+    "isOpen": false,
+    "local_amt": "",
+    "node_key": "",
+    "push_amt": "",
+  },
+  "channels": Array [],
+  "channelsLoading": false,
+  "openingChannel": false,
+  "pendingChannels": Object {
+    "pending_closing_channels": Array [],
+    "pending_force_closing_channels": Array [],
+    "pending_open_channels": Array [],
+    "total_limbo_balance": "",
+  },
+}
+`;

test/reducers/balance.spec.js

@@ -8,5 +8,17 @@ describe('reducers', () => {
     it('should handle initial state', () => {
       expect(balanceReducer(undefined, {})).toMatchSnapshot()
     })
+
+    it('should handle INCREMENT_COUNTER', () => {
+      expect(balanceReducer(undefined, { type: GET_BALANCE })).toMatchSnapshot()
+    })
+
+    it('should handle DECREMENT_COUNTER', () => {
+      expect(balanceReducer(undefined, { type: RECEIVE_BALANCE })).toMatchSnapshot()
+    })
+
+    it('should handle unknown action type', () => {
+      expect(balanceReducer(undefined, { type: 'unknown' })).toMatchSnapshot()
+    })
   })
 })

test/reducers/channels.spec.js

@@ -0,0 +1,17 @@
+import channelsReducer, {
+  SET_CHANNEL_FORM,
+  SET_CHANNEL,
+  GET_CHANNELS,
+  RECEIVE_CHANNELS,
+  OPENING_CHANNEL,
+  OPENING_SUCCESSFUL,
+  OPENING_FAILURE
+} from '../../app/reducers/channels'
+
+describe('reducers', () => {
+  describe('channelsReducer', () => {
+    it('should handle initial state', () => {
+      expect(channelsReducer(undefined, {})).toMatchSnapshot()
+    })
+  })
+})