IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated read me file [skip ci]

Browse Source
This commit is contained in:
James Cole 2018-01-20 23:59:10 +01:00
parent 447d453fdc
commit 3e3e304ef3
No known key found for this signature in database
GPG Key ID: C16961E655E74B5E
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
readme.md
View File

@ -32,9 +32,9 @@
## Introduction ## Introduction
"Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. Here are some screenshots: "Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. Here are some screenshots:
[![The index of Firefly III](https://firefly-iii.org/static/screenshots/4.6.12/tiny/index.png)](https://firefly-iii.org/static/screenshots/4.6.12/index.png) [![The account overview of Firefly III](https://firefly-iii.org/static/screenshots/4.6.12/tiny/account.png)](https://firefly-iii.org/static/screenshots/4.6.12/account.png) [![The index of Firefly III](https://firefly-iii.org/static/screenshots/4.7.0/tiny/index.png)](https://firefly-iii.org/static/screenshots/4.7.0/index.png) [![The account overview of Firefly III](https://firefly-iii.org/static/screenshots/4.7.0/tiny/account.png)](https://firefly-iii.org/static/screenshots/4.7.0/account.png)
[![Overview of all budgets](https://firefly-iii.org/static/screenshots/4.6.12/tiny/budget.png)](https://firefly-iii.org/static/screenshots/4.6.12/budget.png) [![Overview of a category](https://firefly-iii.org/static/screenshots/4.6.12/tiny/category.png)](https://firefly-iii.org/static/screenshots/4.6.12/category.png) [![Overview of all budgets](https://firefly-iii.org/static/screenshots/4.7.0/tiny/budget.png)](https://firefly-iii.org/static/screenshots/4.7.0/budget.png) [![Overview of a category](https://firefly-iii.org/static/screenshots/4.7.0/tiny/category.png)](https://firefly-iii.org/static/screenshots/4.7.0/category.png)
### Purpose ### Purpose
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, 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,
@ -47,41 +47,41 @@ You can read more about this on [the website](https://firefly-iii.org/).
### Features ### Features
Most importantly... Most importantly...
* Firefly III runs on your own server, so you are fully in control of your data. It will not contact other sites or servers; * Firefly III runs on your own server, so you are fully in control of your data. It will not contact other sites or servers
* You can import from over 2500 financial providers, in 55 countries when you enable the [Spectre API](https://www.saltedge.com/solutions_for_finapps); * You can import from over 2500 financial providers, in 55 countries when you enable the [Spectre API](https://www.saltedge.com/solutions_for_finapps)
* You can import CSV files from practically any bank; * You can import CSV files from practically any bank
* If you feel you’re missing something you can just ask me and I’ll add it! * If you feel you’re missing something you can just ask me and I’ll add it!
But actually, it features: But actually, it features:
* [A double-entry bookkeeping system](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system); * [A double-entry bookkeeping system](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system)
* You can store, edit and remove [withdrawals, deposits and transfers](https://firefly-iii.org/guide-transactions.html). This allows you full financial management; * You can store, edit and remove [withdrawals, deposits and transfers](http://firefly-iii.readthedocs.io/en/latest/concepts/transactions.html). This allows you full financial management
* You can manage different types of accounts; * You can manage different types of accounts
* [Asset](https://firefly-iii.org/guide-accounts.html) accounts * [Asset](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html) accounts
* Shared [asset accounts](https://firefly-iii.org/guide-accounts.html) ([household accounts](https://firefly-iii.org/guide-accounts.html)) * Shared [asset accounts](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html) ([household accounts](http://firefly-iii.readthedocs.io/en/latest/concepts/accounts.html))
* Saving accounts * Saving accounts
* Credit cards * Credit cards
* It's possible to create, change and manage money using _[budgets](https://firefly-iii.org/guide-budgets.html)_; * It's possible to create, change and manage money using _[budgets](http://firefly-iii.readthedocs.io/en/latest/concepts/budgets.html)_
* Organize transactions using categories; * Organize transactions using categories
* Save towards a goal using [piggy banks](https://firefly-iii.org/guide-piggy-banks.html); * Save towards a goal using [piggy banks](http://firefly-iii.readthedocs.io/en/latest/advanced/piggies.html)
* Predict and anticipate [bills](https://firefly-iii.org/guide-bills.html); * Predict and anticipate [bills](http://firefly-iii.readthedocs.io/en/latest/advanced/bills.html)
* View income / expense [reports](https://firefly-iii.org/guide-reports.html); * View income / expense [reports](http://firefly-iii.readthedocs.io/en/latest/advanced/reports.html)
* [Rule based](https://firefly-iii.org/guide-rules.html) transaction handling with the ability to create your own rules. * [Rule based](http://firefly-iii.readthedocs.io/en/latest/advanced/rules.html) transaction handling with the ability to create your own rules.
* The ability to export data so you can move to another system. * The ability to [export data](http://firefly-iii.readthedocs.io/en/latest/import/export.html) so you can move to another system.
* The ability to _import_ data so you can move _from_ another system. * The ability to [import data](http://firefly-iii.readthedocs.io/en/latest/import/csv.html) so you can move _from_ another system.
* Organize expenses using tags; * Organize expenses using [tags](http://firefly-iii.readthedocs.io/en/latest/concepts/tags.html)
* 2 factor authentication for extra security 🔒; * 2 factor authentication for extra security 🔒
* Supports any currency you want, including crypto currencies such as ₿itcoin and Ξthereum. * Supports any currency you want, including [crypto currencies](http://firefly-iii.readthedocs.io/en/latest/concepts/currencies.html) such as ₿itcoin and Ξthereum
* Lots of help text in case you don’t get it. * Lots of help text in case you don’t get it
Everything is organised: Everything is organised:
* Clear views that should show you how you're doing; * Clear views that should show you how you're doing
* Easy navigation through your records; * Easy navigation through your records
* Browse back and forth to see previous months or even years; * Browse back and forth to see previous months or even years
* Lots of charts because we all love them; * Lots of charts because we all love them
* Financial reporting showing you how well you are doing; * Financial reporting showing you how well you are doing
* Lots of math because we all love it. * Lots of math because we all like math!
### Who is it for? ### Who is it for?
This application is for people who want to track their finances, keep an eye on their money **without having to upload their financial records to the cloud**. You're a bit tech-savvy, you like open source software and you don't mind tinkering with (self-hosted) servers. This application is for people who want to track their finances, keep an eye on their money **without having to upload their financial records to the cloud**. You're a bit tech-savvy, you like open source software and you don't mind tinkering with (self-hosted) servers.