From d2eb6a7e4a83650802897364e42cc35df23db25e Mon Sep 17 00:00:00 2001 From: Adam Soltys Date: Thu, 4 Aug 2022 23:21:46 -0700 Subject: update readme --- README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index da59f04e..1c94f46b 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,11 @@ Coinos is a bitcoin wallet app that supports payments over the bitcoin, liquid and lightning networks. Try it out at coinos.io. -This repository contains the code for the backend API server which is implemented as a NodeJS application. The code for the frontend UI is tracked separately here (but is automatically installed & started via the Docker way outlined below). +This repository contains the code for the backend API server which is implemented as a NodeJS application. The code for the frontend UI is tracked separately here. -## Install/Run (the Docker way) +## Install -### Requirements - -* docker and docker-compose -* NodeJS (recommended version: 16) -* ~7GB of hard drive space (which will go into /var/lib/docker; primarily for Liquid) - -### Getting Started +The follow commands will set up bitcoin, liquid and lightning nodes in regtest mode, along with a coinos app server, database, and front end UI. You'll need to have docker installed as a pre-requisite. ```bash git clone https://github.com/coinos/coinos-server -- cgit v1.2.3