Update README with comprehensive project documentation and roadmap

This commit is contained in:
jessikitty committed 2025-12-18 15:24:43 +11:00
1 parent 30a1d5ac54
commit f9da802872
1 file changed
+1 -3
+1 -3
View File
@@ -1,3 +1 @@
# family-hub
Comprehensive home management system for calendar, chores, menu planning, and shopping lists with Mealie and Home Assistant integration
IyBGYW1pbHkgSHViIC0gSG9tZSBNYW5hZ2VtZW50IFN5c3RlbQoKPiAqKiJTa3lsaWdodCBvbiBTdGVyb2lkcyIqKiAtIEEgY29tcHJlaGVuc2l2ZSBmYW1pbHkgbWFuYWdlbWVudCBzeXN0ZW0gZm9yIGNhbGVuZGFyLCBjaG9yZXMsIG1lbnUgcGxhbm5pbmcsIGFuZCBzaG9wcGluZyBsaXN0cwoKLS0tCgojIyDwn4+gIFByb2plY3QgT3ZlcnZpZXcKCkZhbWlseSBIdWIgaXMgYSBzdGFuZGFsb25lIGhvbWUgbWFuYWdlbWVudCBzeXN0ZW0gZGVzaWduZWQgZm9yIGEgZmFtaWx5IG9mIDUgKExvdSwgSmVzcywgV2lsbGlhbSwgWGFuZGVyLCBCZWxsYSkgdG8gbWFuYWdlIGRhaWx5IGhvdXNlaG9sZCB0YXNrcywgY29vcmRpbmF0ZSBzY2hlZHVsZXMsIHBsYW4gbWVhbHMsIGFuZCB0cmFjayBzaG9wcGluZyBuZWVkcy4KCiMjIyBLZXkgRmVhdHVyZXMKLSAqKvCfk4UgQ2FsZW5kYXIgTWFuYWdlbWVudCoqIC0gR29vZ2xlIENhbGVuZGFyIGludGVncmF0aW9uIGZvciBmYW1pbHkgc2NoZWR1bGluZwotICoq8J+nuSBDaG9yZSBUcmFja2luZyoqIC0gSW50ZWxsaWdlbnQgYXNzaWdubWVudCBhbmQgdHJhY2tpbmcgc3lzdGVtCi0gKirwn43977iPIE1lbnUgUGxhbm5pbmcqKiAtIE1lYWxpZSBpbnRlZ3JhdGlvbiBmb3IgbWVhbCBwbGFubmluZwotICoq8J+bkiBTaG9wcGluZyBMaXN0cyoqIC0gQXV0by1nZW5lcmF0ZWQgZnJvbSBtZWFsIHBsYW5zIHdpdGggbWFudWFsIGFkZGl0aW9ucwotICoq8J+PoSBIb21lIEFzc2lzdGFudCBJbnRlZ3JhdGlvbioqIC0gUHVzaCBub3RpZmljYXRpb25zIGFuZCBkYXNoYm9hcmQgY2FyZHMKLSAqKvCfkaUgTXVsdGktVXNlciBTeXN0ZW0qKiAtIEluZGl2aWR1YWwgcHJvZmlsZXMgd2l0aCByb2xlLWJhc2VkIHZpZXdzCgotLS0KCiMjIPCfkajigI3wn5Gp4oCN8J+Rp+KAjfCfkaYgRmFtaWx5IENvbmZpZ3VyYXRpb24KCiMjIyBNZW1iZXJzCi0gKipMb3UqKiAoUGFyZW50KQotICoqSmVzcyoqIChQYXJlbnQpIC0gTWFzdGVyIEJlZHJvb20gd2l0aCBFbnN1aXRlCi0gKipXaWxsaWFtKiogKENoaWxkKSAtIE93biBCZWRyb29tCi0gKipYYW5kZXIqKiAoQ2hpbGQpIC0gT3duIEJlZHJvb20KLSAqKkJlbGxhKiogKENoaWxkKSAtIE93biBCZWRyb29tCgojIyMgUGV0cwotICoqSGFycGVyKiogKERvZykgLSBGZWVkaW5nLCB3YXRlcmluZwotICoqQ2hpcHMqKiAoQ2F0KSAtIEZlZWRpbmcsIHdhdGVyaW5nLCBsaXR0ZXIgbWFpbnRlbmFuY2UKCiMjIyBIb21lIExheW91dAotIDUgQmVkcm9vbXMgKDEgTWFzdGVyIHdpdGggRW5zdWl0ZSkKLSAyIEJhdGhyb29tcwotIDEgVG9pbGV0Ci0gS2l0Y2hlbiAod2l0aCBkaXNod2FzaGVyKQotIERpbmluZyBSb29tCi0gTGF1bmRyeSAod2FzaGluZyBtYWNoaW5lICsgZHJ5ZXIpCgojIyMgV2Vla2x5IFNjaGVkdWxlIE5vdGVzCi0gKipCaW4gRGF5Kio6IFdlZG5lc2RheSBtb3JuaW5nIHBpY2t1cAotICoqUmVjeWNsaW5nL0dyZWVucyoqOiBBbHRlcm5hdGUgZm9ydG5pZ2h0cyB3aXRoIHJlZ3VsYXIgYmlucwoKLS0tCgojIyDwn5ug77iPIFRlY2ggU3RhY2sKCiMjIyBCYWNrZW5kCi0gKipGcmFtZXdvcmsqKjogRmFzdEFQSSAoUHl0aG9uIDMuMTErKQotICoqRGF0YWJhc2UqKjogU1FMaXRlIChwcm9kdWN0aW9uLXJlYWR5LCBjYW4gbWlncmF0ZSB0byBQb3N0Z3JlU1FMKQotICoqQXV0aGVudGljYXRpb24qKjogSldULWJhc2VkIHdpdGggYmNyeXB0IHBhc3N3b3JkIGhhc2hpbmcKLSAqKkFQSSBEb2N1bWVudGF0aW9uKio6IEF1dG9tYXRpYyBPcGVuQVBJL1N3YWdnZXIKCiMjIyBGcm9udGVuZAotICoqRnJhbWV3b3JrKio6IFJlYWN0IDE4IHdpdGggVHlwZVNjcmlwdAotICoqU3R5bGluZyoqOiBUYWlsd2luZCBDU1MKLSAqKlN0YXRlIE1hbmFnZW1lbnQqKjogUmVhY3QgQ29udGV4dCBBUEkgLyBadXN0YW5kCi0gKipCdWlsZCBUb29sKio6IFZpdGUKCiMjIyBJbnRlZ3JhdGlvbnMKLSAqKkdvb2dsZSBDYWxlbmRhciBBUEkqKiAtIE9BdXRoMiBhdXRoZW50aWNhdGlvbgotICoqTWVhbGllIEFQSSoqIC0gU2VsZi1ob3N0ZWQgcmVjaXBlL21lYWwgcGxhbm5pbmcKLSAqKkhvbWUgQXNzaXN0YW50KiogLSBSRVNUIEFQSSArIFdlYmhvb2tzIGZvciBub3RpZmljYXRpb25zCgojIyMgSW5mcmFzdHJ1Y3R1cmUKLSAqKkNvbnRhaW5lcml6YXRpb24qKjogRG9ja2VyICsgRG9ja2VyIENvbXBvc2UKLSAqKlJldmVyc2UgUHJveHkqKjogTmdpbnggKG9wdGlvbmFsKQotICoqRGF0YWJhc2UgTWlncmF0aW9ucyoqOiBBbGVtYmljCgotLS0KCiMjIPCfk4sgRGV2ZWxvcG1lbnQgUHJvZ3Jlc3MKCiMjIyDinIUgUGhhc2UgMTogRm91bmRhdGlvbiAmIENvcmUgU2V0dXAKLSBbeF0gQ3JlYXRlIEdpdCByZXBvc2l0b3J5Ci0gW3hdIFByb2plY3Qgc3RydWN0dXJlIHNjYWZmb2xkaW5nCi0gWyBdIEJhY2tlbmQgQVBJIGZyYW1ld29yayBzZXR1cAotIFsgXSBGcm9udGVuZCBSZWFjdCBhcHBsaWNhdGlvbiBzZXR1cAotIFsgXSBEYXRhYmFzZSBzY2hlbWEgZGVzaWduCi0gWyBdIERvY2tlciBjb250YWluZXJpemF0aW9uCi0gWyBdIFVzZXIgbWFuYWdlbWVudCBzeXN0ZW0KCiMjIyDirJwgUGhhc2UgMjogQ2hvcmVzIFN5c3RlbQotIFsgXSBEYXRhYmFzZSBtb2RlbHMgZm9yIGNob3JlcwotIFsgXSBDaG9yZSB0eXBlczogRGFpbHksIFdlZWtseSwgRm9ydG5pZ2h0bHksIEFkLWhvYwotIFsgXSBMb2NhdGlvbi1iYXNlZCBjYXRlZ29yaXphdGlvbgotIFsgXSBBc3NpZ25tZW50IGVuZ2luZSAoaW5kaXZpZHVhbC9zaGFyZWQvcm90YXRpbmcpCi0gWyBdIFJlY3VycmluZyBzY2hlZHVsZSBidWlsZGVyCi0gWyBdIENvbXBsZXRpb24gdHJhY2tpbmcgJiBoaXN0b3J5Ci0gWyBdIENob3JlIGRhc2hib2FyZCBVSQotIFsgXSBUb2RheSdzIHRhc2tzIHZpZXcKLSBbIF0gV2Vla2x5IG92ZXJ2aWV3IGNhbGVuZGFyCgojIyMg4qycIFBoYXNlIDM6IENhbGVuZGFyIEludGVncmF0aW9uCi0gWyBdIEdvb2dsZSBDYWxlbmRhciBPQXV0aDIgc2V0dXAKLSBbIF0gUmVhZC9kaXNwbGF5IGZhbWlseSBldmVudHMKLSBbIF0gQ3JlYXRlL2VkaXQgZXZlbnRzIGludGVyZmFjZQotIFsgXSBTeW5jIGNob3JlcyB0byBjYWxlbmRhciAob3B0aW9uYWwpCi0gWyBdIENhbGVuZGFyIHdpZGdldCBmb3IgZGFzaGJvYXJkCgojIyMg4qycIFBoYXNlIDQ6IE1lbnUgUGxhbm5pbmcgJiBTaG9wcGluZwotIFsgXSBNZWFsaWUgQVBJIGludGVncmF0aW9uCi0gWyBdIFdlZWtseSBtZWFsIHBsYW5uZXIgaW50ZXJmYWNlCi0gWyBdIFJlY2lwZSBicm93c2VyCi0gWyBdIEF1dG8tZ2VuZXJhdGUgc2hvcHBpbmcgbGlzdHMgZnJvbSBtZWFscwotIFsgXSBNYW51YWwgc2hvcHBpbmcgbGlzdCBtYW5hZ2VtZW50Ci0gWyBdIEl0ZW0gY2F0ZWdvcml6YXRpb24KLSBbIF0gQ2hlY2stb2ZmIGZ1bmN0aW9uYWxpdHkKLSBbIF0gTW9iaWxlLWZyaWVuZGx5IHNob3BwaW5nIHZpZXcKCiMjIyDirJwgUGhhc2UgNTogUG9saXNoICYgSW50ZWdyYXRpb24KLSBbIF0gVW5pZmllZCBkYXNoYm9hcmQgaG9tZSB2aWV3Ci0gWyBdIFdpZGdldC1zdHlsZSBsYXlvdXQgc3lzdGVtCi0gWyBdIFF1aWNrIHN0YXRzICYgaW5kaWNhdG9ycwotIFsgXSBIb21lIEFzc2lzdGFudCBSRVNUIEFQSSBlbmRwb2ludHMKLSBbIF0gUHVzaCBub3RpZmljYXRpb24gc3lzdGVtCiAgLSBbIF0gT3ZlcmR1ZSBjaG9yZXMKICAtIFsgXSBCaW4gZGF5IHJlbWluZGVycyAoVHVlc2RheSBuaWdodCkKICAtIFsgXSBQZXQgY2FyZSByZW1pbmRlcnMKLSBbIF0gSG9Line truncated