From 2ee4d65c8d594ff0c1a46766676a5255b0311a89 Mon Sep 17 00:00:00 2001 From: Thomas <4159106+dtslvr@users.noreply.github.com> Date: Sat, 17 Apr 2021 16:30:03 +0200 Subject: [PATCH] Improve documentation (#5) * Improve documentation * Extend feature section * Improve getting started instructions * Extend README.md * Minor change * Refactor list --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c389af912..46b8ebbff 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,40 @@ Privacy-first Portfolio Tracker
- Ghostfolio + Live Demo
+**Ghostfolio** is a privacy-first portfolio tracker. It empowers busy folks to have a sharp look of their financial assets and to make solid, data-driven investment decisions by evaluating automated Static Portfolio Analysis Rules. + +## Why Ghostfolio? + +Ghostfolio is for you if you are... + +- ๐ผ trading stocks, ETFs or cryptocurrencies on multiple platforms + +- ๐ฆ pursuing a buy & hold strategy + +- ๐ฏ interested in getting insights of your portfolio composition + +- ๐ป valuing privacy and data ownership + +- ๐ง into minimalism + +- ๐งบ caring about diversifying your financial resources + +- ๐ interested in financial independence + +- ๐ saying no to spreadsheets in 2021 + +- ๐ still reading this list + ## 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,10 +53,10 @@ 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` +7. Login as _Admin_ with the following _Security Token_: `ae76872ae8f3419c6d6f64bf51888ecbcc703927a342d815fafe486acdb938da07d0cf44fca211a0be74a423238f535362d390a41e81e633a9ce668a6e31cdf9` ## Development