Skip to content

Commit

Permalink
add: README
Browse files Browse the repository at this point in the history
  • Loading branch information
djhunter67 committed Aug 30, 2023
1 parent 6a163ae commit 3ded42e
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This project, henceforth, will recongnize [semantic versioning](https://semver.o
Here we write upgrade and change notes.

MAJOR version when you make incompatible API changes,
⭐ MAJOR version when you make incompatible API changes,

✴️ MINOR version when you add functionality in a backwards compatible manner

Expand Down
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Personal Bugdet Application

## Objective
- Get a handle on one's personal finances.
- Take in expense information.
- Save previous expenses.
- Analyze all previous data to identify trends in expenses.
- Take advantage of interoperating with personal financial institutions.
- Written in Rust.
- Expose a web interface to the internet.
- Self-hosted.

## Features
- [ ] Progressive Web App.
- [ ] Take in expense information.
- [ ] Save previous expenses.
- [ ] Analyze all previous data to identify trends in expenses.
- [ ] Take advantage of interoperating with personal financial institutions.
- [ ] Written in Rust.

## Installation
- [ ] Download the executable.
- [ ] Run the executable.
- [ ] Access the application at `localhost:8000`.
- [ ] Access the application from the internet at `TBD`.

## Usage
- [ ] Login or create an account.
- [ ] Enter expense information.
- [ ] View previous expenses.
- [ ] View trends in expenses.
- [ ] Link a personal financial institution.

## Contributing
- [ ] Fork the repository.
- [ ] Make changes.
- [ ] Submit a pull request.



0 comments on commit 3ded42e

Please sign in to comment.