From 3ded42ed1f7586ebf6c5904652e4eab27c78e5d9 Mon Sep 17 00:00:00 2001 From: Christerpher Hunter Date: Wed, 30 Aug 2023 12:44:14 -0400 Subject: [PATCH] add: README --- CHANGELOG.md | 2 +- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index caca6a6..0bf1a9b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..3fb673c --- /dev/null +++ b/README.md @@ -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. + + +