From bf5ec6a929214f71c40ecfe0a91ece99119d1a67 Mon Sep 17 00:00:00 2001 From: Thomas <4159106+dtslvr@users.noreply.github.com> Date: Sat, 17 Apr 2021 09:18:49 +0200 Subject: [PATCH] Improve documentation * Extend feature section * Improve getting started instructions --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c389af912..6dc405b11 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ ## Features +- ✅ Create, update and delete transactions +- ✅ Portfolio performance (`Today`, `YTD`, `1Y`, `5Y`, `Max`) +- ✅ Various charts +- ✅ Static analysis to identify potential risks in your portfolio - ✅ Dark Mode ## Getting Started @@ -25,8 +29,8 @@ 1. Run `yarn install` 2. Run `cd docker` 3. Run `docker compose build` -4. Run `docker compose up -d` -5. Run `yarn setup:database` +4. Run `docker compose up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) +5. Run `yarn setup:database` to initialize the database schema and populate your database with (example) data 6. Start server and client (see _Development_) 7. Login as _Admin_ with the `Security Token`: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9`