Merge pull request #100 from range-of-motion/99-reorganize-readme

Reorganize README.md

README.md

@@ -1,50 +1,43 @@
-[![Build Status](https://travis-ci.com/range-of-motion/budget.svg?branch=master)](https://travis-ci.com/range-of-motion/budget)
-[![GitHub issues](https://img.shields.io/github/issues/range-of-motion/budget.svg)](https://github.com/range-of-motion/budget/issues)
-[![GitHub stars](https://img.shields.io/github/stars/range-of-motion/budget.svg)](https://github.com/range-of-motion/budget/stargazers)
-[![GitHub license](https://img.shields.io/github/license/range-of-motion/budget.svg)](https://github.com/range-of-motion/budget/blob/master/LICENSE)
-
 # Budget
 
-https://budget.pixely.me
+![GitHub latest release](https://img.shields.io/github/v/release/range-of-motion/budget?include_prereleases)
+![GitHub downloads](https://img.shields.io/github/downloads/range-of-motion/budget/total)
+[![Build status](https://travis-ci.com/range-of-motion/budget.svg?branch=master)](https://travis-ci.com/range-of-motion/budget)
+[![GitHub license](https://img.shields.io/github/license/range-of-motion/budget.svg)](https://github.com/range-of-motion/budget/blob/master/LICENSE)
 
 Budget is an open-source web application that helps you keep track of your finances.
 
+You can use Budget by hosting it yourself, or using [the instance hosted by us](https://budget.pixely.me).
+
 ![Product](https://user-images.githubusercontent.com/9268822/46098425-a8877300-c1c4-11e8-9293-f43ceb9d6f97.png)
 
 ## Features
 
-* Ability to organize spendings using tags
-* Dashboard displaying monthly statistics about your spendings
-* Available in multiple languages (English, Dutch, Danish, German)
-
-## Installation
-
-```
-composer install --no-dev
-yarn install
-
-cp .env.example .env
-php artisan key:generate
-
-php artisan storage:link
+* Insertion and management of transactions
+* Ability to organize transactions using tags
+* Support for importing transactions (CSV format)
+* Reports that visualize financials (showing weekly balance and most expensive tags, for example)
+* Supports multiple currencies
+* Available in multiple languages
+* Weekly summary available through e-mail
 
-php artisan migrate
+## Requirements
 
-yarn run development
+* PHP 7.2.5 or higher
+* HTTP server (for example Apache or NGINX)
+* MySQL
+* Composer
+* Node.js
 
-php artisan serve
-
-php artisan queue:work
-```
-
-In addition to this you will have to create a cronjob to trigger budgets scheduling.  
-(Without this, recurring transactions and weekly reports won't work)
+## Installation
 
-```
-* * * * * cd /path/to/budget/ && php artisan schedule:run >> 2>&1 
-``` 
+* Clone the repository (`git clone https://github.com/range-of-motion/budget.git`)
+    * You should always check out a tag, since the `master` branch might not always be stable (`git checkout TAG`)
+* Run installation command (`php artisan budget:install`)
+* Configure additional services in `.env` (database or mail, for example)
+* Head over to your list of crons (`crontab -e`) and add `* * * * * cd /path-to-budget && php artisan schedule:run >> /dev/null 2>&1`
 
-It's best to make sure this command is run with the user that runs budget (eg. www-data) 
+*Note that in order for certain features to work properly, the jobs queue needs to be watched. This can be done by either running `php artisan queue:work` or using [Supervisor](https://laravel.com/docs/7.x/queues#supervisor-configuration).*
 
 ## Contact