diff --git a/README.md b/README.md index 7df3216..5131bc2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ Investbrain helps you manage and track the performance of your investments.

Investbrain Screenshot

+## Installation + +Coming soon. + +## 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: