diff --git a/README.md b/README.md index 384bcf4..aa5003c 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,19 @@ Investbrain helps you manage and track the performance of your investments.

Investbrain Screenshot

+## Under the hood + +Investbrain is a Laravel PHP web application that leverages the Livewire and Mary UI frameworks for its frontend. As far as persistent data storage, any relational database should work (but we generally recommend SQLite or MySQL). There are out of the box market data providers for Yahoo Finance, Alpha Vantage, and an extensible market data provider interface. We also have robust i18n, a11y, and dark mode support. + ## Installation For ease of installation, we highly recommend installing Investbrain in a Docker container using the provided Docker Compose option, which downloads all the necessary dependencies and builds everything you need to get started quickly! -To get started, you can clone this repository: +Before getting started, you should already have the following installed on your machine: Docker Desktop or CLI, Git, and a wild sense of adventure. + +Ready? Let's get started! + +First, you can clone this repository: ```bash git clone https://github.com/investbrainapp/investbrain.git . @@ -66,10 +74,6 @@ docker compose up Easy as that! -## Under the hood - -Investbrain is a Laravel PHP web application that leverages the Livewire and Mary UI frameworks for its frontend. As far as persistent data storage, any relational database should work (but we generally recommend SQLite or MySQL). There are out of the box market data providers for Yahoo Finance, Alpha Vantage, and an extensible market data provider interface. We also have robust i18n, a11y, and dark mode support. - ## Contributing We appreciate any contributions to Investbrain! Please open a pull request on our [Github repository](https://github.com/investbrainapp/investbrain). Here are some ideas for first time contributors: