diff --git a/README.md b/README.md index 13382ea244..32eb7bd7aa 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,44 @@ -Firefly III (v3.4.0.3) -=========== +# Firefly III (v3.4.0.3) [![Build Status](https://travis-ci.org/JC5/firefly-iii.svg?branch=develop)](https://travis-ci.org/JC5/firefly-iii) [![Project Status](http://stillmaintained.com/JC5/firefly-iii.png?a=b)](http://stillmaintained.com/JC5/firefly-iii) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/d44c7012-5f50-41ad-add8-8445330e4102/mini.png)](https://insight.sensiolabs.com/projects/d44c7012-5f50-41ad-add8-8445330e4102) [![Code Climate](https://codeclimate.com/github/JC5/firefly-iii/badges/gpa.svg)](https://codeclimate.com/github/JC5/firefly-iii) [![Coverage Status](https://coveralls.io/repos/JC5/firefly-iii/badge.svg?branch=master)](https://coveralls.io/r/JC5/firefly-iii?branch=master) -[![Coverage Status](https://coveralls.io/repos/JC5/firefly-iii/badge.svg?branch=develop)](https://coveralls.io/r/JC5/firefly-iii?branch=develop) - [![Latest Stable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/stable.svg)](https://packagist.org/packages/grumpydictator/firefly-iii) -[![Total Downloads](https://poser.pugx.org/grumpydictator/firefly-iii/downloads.svg)](https://packagist.org/packages/grumpydictator/firefly-iii) -[![Latest Unstable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/unstable.svg)](https://packagist.org/packages/grumpydictator/firefly-iii) -[![License](https://poser.pugx.org/grumpydictator/firefly-iii/license.svg)](https://packagist.org/packages/grumpydictator/firefly-iii) -Firefly III is a tool to help you manage your finances. Please read the full description [in the wiki](https://github.com/JC5/firefly-iii/wiki/full-description). +## About -Firefly Mark III is a new version of Firefly built upon best practices and lessons learned -from building [Firefly](https://github.com/JC5/Firefly). It's Mark III since the original Firefly never made it outside of my -laptop and [Firefly II](https://github.com/JC5/Firefly) is live. - -If you're not sure if this tool is for you, please read the [full description](https://github.com/JC5/firefly-iii/wiki/full-description). - -To install and use Firefly III, please read [the installation guide](https://github.com/JC5/firefly-iii/wiki/Installation), - [the upgrade guide](https://github.com/JC5/firefly-iii/wiki/Upgrade-instructions) (if applicable) and the **[first use guide](https://github.com/JC5/firefly-iii/wiki/First-use)**. +"Firefly III" is a financial manager. It can help you keep track of expenses, income, budgets and everything in between. It even supports credit cards, shared +household accounts and savings accounts! It's pretty fancy. The end goal is to save money. -If you want to try out Firefly III, you can do so on [this dedicated website](https://geld.nder.be/). This site always runs the latest version of Firefly III. If you want to use it, please read the [privacy considerations](https://github.com/JC5/firefly-iii/wiki/Privacy-on-demo-site) for this demo-site. +Firefly is a system you'll have install yourself on webhosting of your choosing. + +Personal financial management is pretty difficult, and everybody has their own approach to it. Some people +make budgets, other people limit their cashflow by throwing away their credit cards, others get a better job. +There are tons of ways to save and earn money. + + +To get to know Firefly, and to see if it fits you, check out these resources: + +- The screenshots below on this very page. +- The featurelist below, also on this very page. +- The [full description](https://github.com/JC5/firefly-iii/wiki/full-description), which will tell you how Firefly works, +and the philosophy behind it. + + +### About the name (if you care) + +It's III, or 3, because [version 2](https://github.com/JC5/Firefly) and version 1 (not online) preceded it. It has been growing steadily ever since. + +## Running and installing + +If you're still interested please read [the installation guide](https://github.com/JC5/firefly-iii/wiki/Installation), +[the upgrade guide](https://github.com/JC5/firefly-iii/wiki/Upgrade-instructions) (if applicable) +and the **[first use guide](https://github.com/JC5/firefly-iii/wiki/First-use)**. + +If you want to try out Firefly III, you can do so on [this dedicated website](https://geld.nder.be/). +This site always runs the latest version of Firefly III. If you want to use it, please read the [privacy considerations](https://github.com/JC5/firefly-iii/wiki/Privacy-on-demo-site) for this demo-site. ## Current features @@ -40,7 +54,8 @@ If you want to try out Firefly III, you can do so on [this dedicated website](ht - Save towards a goal using piggy banks; - Predict and anticipate bills; - View income / expense reports; -- Lots of help text in case you don't get it; +- Organize expenses using tags; +- Lots of help text in case you don't get it. Everything is organised: @@ -50,22 +65,6 @@ Everything is organised: - Lots of charts because we all love them. - Financial reporting showing you how well you are doing; -## Changes - -Firefly III will feature, but does not feature yet: - - -- More control over other resources outside of personal finance - - Debts -- More test-coverage; -- Firefly will be able to split transactions; a single purchase can be split in multiple entries, for more fine-grained control. -- Firefly will be able to join transactions. -- Any other features I might not have thought of. - -Some stuff has been removed: - -- The nesting of budgets, categories and beneficiaries is removed because it was pretty pointless. - ## Screenshots ![Index](https://i.nder.be/c09vfw90) @@ -83,6 +82,7 @@ Some stuff has been removed: ![Piggy banks](https://i.nder.be/hkud0h53) ## Current state -I have the basics up and running. Test coverage is currently coming, slowly. -Questions, ideas or other things to contribute? [Let me know](https://github.com/JC5/firefly-iii/issues/new)! +Firefly III is pretty much all grown up. Full test coverage (nerd alert!) is coming. + +Questions, ideas, bugs or other things to contribute? [Let me know](https://github.com/JC5/firefly-iii/issues/new)!