Extended read me [skip-ci]

This commit is contained in:
James Cole 2014-07-09 14:10:54 +02:00
parent eb3967d474
commit 41079aad77

View File

@ -5,8 +5,8 @@ firefly-iii
[![Coverage Status](https://coveralls.io/repos/JC5/firefly-iii/badge.png?branch=master)](https://coveralls.io/r/JC5/firefly-iii?branch=master)
Firefly Mark III is a new version of Firefly built upon best practices and lessons learned
from building Firefly. It's Mark III since the original Firefly never made it outside of my
laptop and Firefly II is live.
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.
## Changes
@ -23,7 +23,7 @@ Firefly III will feature:
- More test-coverage (aka: actual test coverage);
## More features
- 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.
- Transfers and transactions will be combined into one internal datatype which is more consistent with what you're actually doing: moving money from A to B. The fact that A or B or both are yours should not matter. And it will not, in the future.
@ -35,4 +35,15 @@ Firefly III will feature:
- Firefly will not encrypt the content of the (MySQL) tables. Old versions of Firefly had this capability but it sucks when searching, sorting and organizing entries.
## Current state
I barely have the basics up and running and I'm already running behind on test coverage. I _do_ have some good ideas about user configuration and preferences which was a huge pain in the butt with the previous Firefly.
I barely have the basics up and running and test coverage is doing very good. I have some good ideas about user configuration and preferences which was a huge pain in the butt with the previous Firefly.
Current problems include proper time-based navigation (how and when to switch to the next month, previous week, etc) and the best
way to display your current financial state, which is something that still needs thinking.
The problem is that most peoples finances are very flexible and Firefly can be pretty static. For example, did you spend all your money? Or
do you have money left? Good question: when your rent is due at the 1st of the month Firefly might think you've spent way too much. But
marking it as some kind of "bill" will make Firefly ignore it, but it might make Firefly forget that you've got bills coming! So there's
a lot to do, and a lot to fix.
If you have an idea, [let me know](https://github.com/JC5/firefly-iii/issues/new)!