From a10b772ac5f0bfef37bee66e73c30e389598e74f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 30 Mar 2018 23:42:56 +0200 Subject: [PATCH] Rewrite README --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 06adc59..f728207 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ -Tutorial Framework Frontend -=========================== +# frontend-tutorial-framework -## Building and running with magic starter +This is the Angular frontend of TFW. -Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally. +The main component it exposes is the `src/app/services/websocket.service.ts` service – providing an RxJS based communication API with the framework backend – and several pre-implemented components for you to used based on it. -This requires the `tutorial-framework-wip` and `tutorial-framework-ng` repositories to have a common parent folder. +To learn more about the framework see the `baseimage-tutorial-framework` repo. For more on building and running TFW (not just the frontend) consult `test-tutorial-framework`. - -## Running with yarn +## Running standalone with yarn Simply execute `yarn start` in the project root.