From d039593b674528f31579216031ca20afe704c846 Mon Sep 17 00:00:00 2001 From: Scott Date: Tue, 27 Nov 2018 08:29:04 +1100 Subject: [PATCH] Update readme to direct development to React branch --- web/README.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/web/README.md b/web/README.md index 4cb8c5ff..f2aeaeac 100644 --- a/web/README.md +++ b/web/README.md @@ -1,8 +1,10 @@ + +## The Angular version of the front-end is being replaced by a React implemtnation on this branch: https://github.com/thrasher-/gocryptotrader/tree/react-web/web + # GoCryptoTrader package Web - [![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader) [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) [![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/web) @@ -10,22 +12,12 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) -This web package is part of the GoCryptoTrader codebase. - -## This is still in active development +There will be no further development on the Angular front end and all development should be directed to the new branch until it is merged. You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/) -## Current Features - -+ It can run -+ It can be compiled with Electron to run as an executable -+ Websocket support to listen to GoCryptoTrader events -+ Material design -+ Has a semi-working Settings page -+ Has a basic ticker dashboard ## Install dependencies with npm @@ -48,10 +40,7 @@ npm run start:web Currently runs with: -- Angular v6.0.9 -- Angular-CLI v6.0.8 -- Electron v1.8.7 -- Electron Builder v20.0.4 +- Angular v7 ## To build for production