Skip to content

Commit cf22491

Browse files
committed
Doc: Update README with project highlights
1 parent f934335 commit cf22491

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For many years, I have used Google Sheets to record how my money comes in and go
2424

2525
![Excel Data](app/static/images/excel_data.png)
2626

27-
It works well, but it is quite cumbersome to use over a long period of time. For example, I have to manually create the table structures occassionally. I also have to manually add the formulas to generate a chart of my income and expenses. Google Sheets allows me to organize my data, and the data is presentable, but if I cannot quickly visualize it, then it is hard to know what is going on.
27+
It works well, but it is quite cumbersome to use over a long period of time. For example, I have to manually create the table structures occassionally. I also have to manually add the formulas to generate a chart of my income and expenses. Google Sheets allows me to organize my data, and the data is presentable, but if I cannot quickly visualize this data, then it is hard to know what is going on.
2828

2929

3030
Besides detailed budget, income and expenses data, I wanted to have a summary of the health status of my money. I would compare my expenses to my budget and see if I was spending too much. Of course, expenses are made possible by my income. This cashflow is what can enable one to buy an asset and experience freedom or live a liability-filled life.
@@ -40,7 +40,7 @@ Mbeca Ciaku is an attempt to create an easier solution to this small problem. Be
4040
### Sample financial statement on Mbeca Ciaku
4141

4242

43-
![Visualize Financial Statement](app/static/images/visualize_financial_statement.png)
43+
![Visualize Financial Statement](app/static/images/income_statement.png)
4444

4545

4646
Inspired by [MPesa](https://en.wikipedia.org/wiki/M-Pesa), I found the encryption process of personal data very interesting. This feature is really useful. In the MPesa context, the need to guard against the rampant MPesa fraud cases is critical. If you are an active MPesa user, sometimes you would like to refer to your transactions to settle a dispute, confirm a payment, or to make a complaint. Whatever the case, [Safaricom](https://www.safaricom.co.ke/) allows you to easily request for a copy of your transaction data for free. The statement would be sent to you via email. This file is encrypted and can only be accessed by you. At the time of this writing, decrypting the file is dependant on the user providing their National ID number plus a one-time numeric token sent to their phone. The decryption format is "ID-token".
@@ -123,15 +123,15 @@ User
123123
- A random user can register themselves
124124
- They will be required to authenticate themselves before they can access the application
125125
- Can update their financial information (budget, income, expenses, assets, liabilities)
126-
- They can download their data as a encrypted PDF file
126+
- They can download their data as an encrypted PDF file
127127

128128

129129
## How To Use The Application
130130

131131
[Browser 1] Ceate an Admin
132132
- [x] [Create a new admin](http://127.0.0.1:5000/register)
133133
- [x] [Login as admin](http://127.0.0.1:5000/login). You will be redirected to the admin dashboard.
134-
- [x] Create a new support team
134+
- [x] Create a new support team member
135135

136136

137137
[Browser 2] Login as Support Team
@@ -146,7 +146,7 @@ User
146146
- [x] [Create a new user](http://127.0.0.1:5000/register)
147147
- [x] [Login as user](http://127.0.0.1:5000/login). You will be redirected to the user home page.
148148
- [x] [Update your financial information](http://127.0.0.1:5000/update)
149-
- [x] User can optionally download their data as a encrypted PDF file.
149+
- [x] User can optionally download their data as an encrypted PDF file.
150150
- [x] Need help? [Contact support team](http://127.0.0.1:5000/help)
151151

152152

@@ -223,7 +223,7 @@ User
223223

224224
# Or
225225

226-
# Get password from https://www.grc.com/passwords.htm
226+
# Get random value from https://www.grc.com/passwords.htm
227227

228228
```
229229

@@ -247,6 +247,6 @@ User
247247
## Areas of Improvement
248248

249249
- [ ] User interface design
250-
- [ ] Proper display of multiple graphs on specific charts (based on data years)
250+
- [ ] Proper display of multiple graphs on specific charts (based on the month an item is keyed in)
251251
- [ ] Disabling of the _Edit_ link in the help page after a specified duration
252252
- [ ] Scheduled email notifications to remind users to update their data at the end of a day
198 KB
Loading

0 commit comments

Comments
 (0)