From 11fce543c6ecbb56da8f791685b8760cd1c605db Mon Sep 17 00:00:00 2001 From: Jack Mallers Date: Tue, 15 Aug 2017 17:11:58 -0500 Subject: [PATCH] feature(README): update to MVP level README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4bd6a30..31030a95 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,18 @@ 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. +Zap is built on top of [LND](https://github.com/lightningnetwork/lnd), +uses a Node.js proxy and, +[Electron](https://electron.atom.io/) + [React](https://facebook.github.io/react/) + [Redux](https://github.com/reactjs/redux/tree/master/docs) for the UI. + +Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUyLTE1MDI2OTA0ODAtNTRjMTY4YTNjNA) to discuss development, design and product + ## Install +> For now Zap assumes you are running BTCD and LND (will change soon). Please see [installation](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) to get that setup first + * **Note: requires a node version >= 7 and an npm version >= 4.** -* **If you have installation or compilation issues, please see file a Github issue** +* **If you have installation or compilation issues, please file a Github issue** First, clone the repo via git: ```bash @@ -23,12 +31,14 @@ $ yarn ``` ## Current Todo List (Last updated August 15th) +Join us on [slack](https://join.slack.com/t/zaphq/shared_invite/MjI2MTY4NTcwMDUyLTE1MDI2OTA0ODAtNTRjMTY4YTNjNA) before tackling a todo to avoid duplicate work. This list will be updated daily to show what todos are being worked on ## 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) +- [ ] Use two package.json [structure](https://github.com/electron-userland/electron-builder/wiki/Two-package.json-Structure) +- [ ] General refactor (I know this TODO sucks but the code is a bit sloppy still, need to spend time refactoring) ## Features - [ ] Configurable BTCD + LN node connection (do not assume/rely on localhost)