feat: docs (#53)

Author: kvernon

docs/CHANGELOG.md CHANGELOG.mddocs/CHANGELOG.md renamed to CHANGELOG.md

@@ -1,201 +1,171 @@
 # [4.2.0](https://github.com/kvernon/realty-investor-timeline/compare/v4.1.0...v4.2.0) (2025-02-12)
 
-
 ### Bug Fixes
 
-* address husky ([#52](https://github.com/kvernon/realty-investor-timeline/issues/52)) ([68e38c5](https://github.com/kvernon/realty-investor-timeline/commit/68e38c5621a2f9659fea2ff453f80a5ab5e778e0))
-
+- address husky ([#52](https://github.com/kvernon/realty-investor-timeline/issues/52)) ([68e38c5](https://github.com/kvernon/realty-investor-timeline/commit/68e38c5621a2f9659fea2ff453f80a5ab5e778e0))
 
 ### Features
 
-* updated node + deps ([#51](https://github.com/kvernon/realty-investor-timeline/issues/51)) ([0af133a](https://github.com/kvernon/realty-investor-timeline/commit/0af133a9d83a7ca9f4618d827ad5e53e2f73d63a))
+- updated node + deps ([#51](https://github.com/kvernon/realty-investor-timeline/issues/51)) ([0af133a](https://github.com/kvernon/realty-investor-timeline/commit/0af133a9d83a7ca9f4618d827ad5e53e2f73d63a))
 
 # [4.1.0](https://github.com/kvernon/realty-investor-timeline/compare/v4.0.1...v4.1.0) (2023-03-25)
 
-
 ### Features
 
-* dependency updates ([2194be7](https://github.com/kvernon/realty-investor-timeline/commit/2194be74de263a44536243d018a1fb20bfec4a68))
-* node update 18 ([d63ad07](https://github.com/kvernon/realty-investor-timeline/commit/d63ad0764deedeeef7efa0377d72ae776f05fd3d))
+- dependency updates ([2194be7](https://github.com/kvernon/realty-investor-timeline/commit/2194be74de263a44536243d018a1fb20bfec4a68))
+- node update 18 ([d63ad07](https://github.com/kvernon/realty-investor-timeline/commit/d63ad0764deedeeef7efa0377d72ae776f05fd3d))
 
 ## [4.0.1](https://github.com/kvernon/realty-investor-timeline/compare/v4.0.0...v4.0.1) (2022-07-24)
 
-
 ### Bug Fixes
 
-* dependency updates ([ad7986e](https://github.com/kvernon/realty-investor-timeline/commit/ad7986e8c7eeabbf22502e416900ff5dcfb635df))
+- dependency updates ([ad7986e](https://github.com/kvernon/realty-investor-timeline/commit/ad7986e8c7eeabbf22502e416900ff5dcfb635df))
 
 # [4.0.0](https://github.com/kvernon/realty-investor-timeline/compare/v3.2.0...v4.0.0) (2022-01-24)
 
-
 ### Continuous Integration
 
-* updating in hopes of fix for issue: [32] ([647c17e](https://github.com/kvernon/realty-investor-timeline/commit/647c17e8f83ea849aadfcd75308210964579c37b))
-
+- updating in hopes of fix for issue: [32] ([647c17e](https://github.com/kvernon/realty-investor-timeline/commit/647c17e8f83ea849aadfcd75308210964579c37b))
 
 ### BREAKING CHANGES
 
-* this should force change
+- this should force change
 
 # [3.2.0](https://github.com/kvernon/realty-investor-timeline/compare/v3.1.0...v3.2.0) (2022-01-23)
 
-
 ### Features
 
-* dependency updates ([96bb921](https://github.com/kvernon/realty-investor-timeline/commit/96bb9217f3837c6cb093f81bbc5e89eb7904fd99))
+- dependency updates ([96bb921](https://github.com/kvernon/realty-investor-timeline/commit/96bb9217f3837c6cb093f81bbc5e89eb7904fd99))
 
 # [3.1.0](https://github.com/kvernon/realty-investor-timeline/compare/v3.0.0...v3.1.0) (2022-01-22)
 
-
 ### Features
 
-* refactor loop ([a0c7eef](https://github.com/kvernon/realty-investor-timeline/commit/a0c7eef68ebb65d32c8c0102f8650e4eebf42da7))
+- refactor loop ([a0c7eef](https://github.com/kvernon/realty-investor-timeline/commit/a0c7eef68ebb65d32c8c0102f8650e4eebf42da7))
 
 # [3.0.0](https://github.com/kvernon/realty-investor-timeline/compare/v2.3.0...v3.0.0) (2022-01-12)
 
-
 ### Features
 
-* 5 calcs ([1fc7435](https://github.com/kvernon/realty-investor-timeline/commit/1fc7435434e70ad646f8af610bbc5096401d1dd7))
-
+- 5 calcs ([1fc7435](https://github.com/kvernon/realty-investor-timeline/commit/1fc7435434e70ad646f8af610bbc5096401d1dd7))
 
 ### BREAKING CHANGES
 
-* ensure we are updated
+- ensure we are updated
 
 # [2.3.0](https://github.com/kvernon/realty-investor-timeline/compare/v2.2.0...v2.3.0) (2022-01-07)
 
-
 ### Features
 
-* force new BREAKING CHANGES ([15dde90](https://github.com/kvernon/realty-investor-timeline/commit/15dde90391c8176bff767776c92b11a5fb876415))
+- force new BREAKING CHANGES ([15dde90](https://github.com/kvernon/realty-investor-timeline/commit/15dde90391c8176bff767776c92b11a5fb876415))
 
 # [2.2.0](https://github.com/kvernon/realty-investor-timeline/compare/v2.1.0...v2.2.0) (2022-01-07)
 
-
 ### Features
 
-* passive apartments ([a68efbe](https://github.com/kvernon/realty-investor-timeline/commit/a68efbea50441cfa908db2ef95aa224dbdcb1b74))
+- passive apartments ([a68efbe](https://github.com/kvernon/realty-investor-timeline/commit/a68efbea50441cfa908db2ef95aa224dbdcb1b74))
 
 # [2.1.0](https://github.com/kvernon/realty-investor-timeline/compare/v2.0.1...v2.1.0) (2021-11-27)
 
-
 ### Features
 
-* implemented holdrules ([6b84f3d](https://github.com/kvernon/realty-investor-timeline/commit/6b84f3daad352e014faaeb594bc636cdd277045a))
+- implemented holdrules ([6b84f3d](https://github.com/kvernon/realty-investor-timeline/commit/6b84f3daad352e014faaeb594bc636cdd277045a))
 
 ## [2.0.1](https://github.com/kvernon/realty-investor-timeline/compare/v2.0.0...v2.0.1) (2021-11-26)
 
-
 ### Bug Fixes
 
-* generator sum to reduce; summaries calcs ([809b8f9](https://github.com/kvernon/realty-investor-timeline/commit/809b8f9b5cd52162bfd523471f55b710b3859137))
+- generator sum to reduce; summaries calcs ([809b8f9](https://github.com/kvernon/realty-investor-timeline/commit/809b8f9b5cd52162bfd523471f55b710b3859137))
 
 # [2.0.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.8.1...v2.0.0) (2021-11-23)
 
-
 ### Features
 
-* updated rules checks ([49913a5](https://github.com/kvernon/realty-investor-timeline/commit/49913a539d8dc2804ccf8d2b5a9a10ac52828399))
-
+- updated rules checks ([49913a5](https://github.com/kvernon/realty-investor-timeline/commit/49913a539d8dc2804ccf8d2b5a9a10ac52828399))
 
 ### BREAKING CHANGES
 
-* for propertyType add
+- for propertyType add
 
 ## [1.8.1](https://github.com/kvernon/realty-investor-timeline/compare/v1.8.0...v1.8.1) (2021-11-22)
 
-
 ### Bug Fixes
 
-* exposed user ledgercollection ([59325fa](https://github.com/kvernon/realty-investor-timeline/commit/59325facb57a22bb751b4c63cee1c249356ff802))
+- exposed user ledgercollection ([59325fa](https://github.com/kvernon/realty-investor-timeline/commit/59325facb57a22bb751b4c63cee1c249356ff802))
 
 # [1.8.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.7.2...v1.8.0) (2021-11-22)
 
-
 ### Features
 
-* exposed ledgercollection; fixed dates ([5a02949](https://github.com/kvernon/realty-investor-timeline/commit/5a02949ec01a740729b000b4e0bf672941ba6a6c))
+- exposed ledgercollection; fixed dates ([5a02949](https://github.com/kvernon/realty-investor-timeline/commit/5a02949ec01a740729b000b4e0bf672941ba6a6c))
 
 ## [1.7.2](https://github.com/kvernon/realty-investor-timeline/compare/v1.7.1...v1.7.2) (2021-11-19)
 
-
 ### Bug Fixes
 
-* package.json main types correction ([5c42a04](https://github.com/kvernon/realty-investor-timeline/commit/5c42a04e33327108893d27a1dea31325c919fb80))
+- package.json main types correction ([5c42a04](https://github.com/kvernon/realty-investor-timeline/commit/5c42a04e33327108893d27a1dea31325c919fb80))
 
 ## [1.7.1](https://github.com/kvernon/realty-investor-timeline/compare/v1.7.0...v1.7.1) (2021-11-19)
 
-
 ### Bug Fixes
 
-* publish / bundle ([f0bffb9](https://github.com/kvernon/realty-investor-timeline/commit/f0bffb95db34fae5adbff30a60ec3cb0da24aa4c))
+- publish / bundle ([f0bffb9](https://github.com/kvernon/realty-investor-timeline/commit/f0bffb95db34fae5adbff30a60ec3cb0da24aa4c))
 
 # [1.7.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.6.0...v1.7.0) (2021-11-19)
 
-
 ### Features
 
-* currency formatter ([592bd6a](https://github.com/kvernon/realty-investor-timeline/commit/592bd6a49281f106b8fccd99bf768c5bc5548977))
+- currency formatter ([592bd6a](https://github.com/kvernon/realty-investor-timeline/commit/592bd6a49281f106b8fccd99bf768c5bc5548977))
 
 # [1.6.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.5.0...v1.6.0) (2021-11-18)
 
-
 ### Features
 
-* expose ledger collection summaries ([083c4d3](https://github.com/kvernon/realty-investor-timeline/commit/083c4d3f0b41a842d599fadc8cf8d1c5777bc8d1))
+- expose ledger collection summaries ([083c4d3](https://github.com/kvernon/realty-investor-timeline/commit/083c4d3f0b41a842d599fadc8cf8d1c5777bc8d1))
 
 # [1.5.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.4.0...v1.5.0) (2021-11-18)
 
-
 ### Features
 
-* easier start ([073a73a](https://github.com/kvernon/realty-investor-timeline/commit/073a73aa4f4039550f11798a2736c52e018e64e2))
+- easier start ([073a73a](https://github.com/kvernon/realty-investor-timeline/commit/073a73aa4f4039550f11798a2736c52e018e64e2))
 
 # [1.4.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.3.0...v1.4.0) (2021-11-14)
 
-
 ### Bug Fixes
 
-* updating publish ([c64ae48](https://github.com/kvernon/realty-investor-timeline/commit/c64ae48f7919a4759542c455f2f82b78df95e71c))
-
+- updating publish ([c64ae48](https://github.com/kvernon/realty-investor-timeline/commit/c64ae48f7919a4759542c455f2f82b78df95e71c))
 
 ### Features
 
-* user ([85d60ba](https://github.com/kvernon/realty-investor-timeline/commit/85d60bac9c4a04bff9b21536c404ab2ec3dd90f9))
+- user ([85d60ba](https://github.com/kvernon/realty-investor-timeline/commit/85d60bac9c4a04bff9b21536c404ab2ec3dd90f9))
 
 # [1.3.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.2.0...v1.3.0) (2021-11-08)
 
-
 ### Features
 
-* property life-cycle ([ee2a5c7](https://github.com/kvernon/realty-investor-timeline/commit/ee2a5c7c4d5af351cf5096ca55c3af5aef1bddcb))
+- property life-cycle ([ee2a5c7](https://github.com/kvernon/realty-investor-timeline/commit/ee2a5c7c4d5af351cf5096ca55c3af5aef1bddcb))
 
 # [1.2.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.1.0...v1.2.0) (2021-10-14)
 
-
 ### Features
 
-* created ledger ([7c08707](https://github.com/kvernon/realty-investor-timeline/commit/7c08707f956c0a8222418b9999c87f8ebe3e5608))
+- created ledger ([7c08707](https://github.com/kvernon/realty-investor-timeline/commit/7c08707f956c0a8222418b9999c87f8ebe3e5608))
 
 # [1.1.0](https://github.com/kvernon/realty-investor-timeline/compare/v1.0.2...v1.1.0) (2021-10-03)
 
-
 ### Features
 
-* single family factory ([45ba72f](https://github.com/kvernon/realty-investor-timeline/commit/45ba72f1522b85eccc5454084adf40a820ac0753))
+- single family factory ([45ba72f](https://github.com/kvernon/realty-investor-timeline/commit/45ba72f1522b85eccc5454084adf40a820ac0753))
 
 ## [1.0.2](https://github.com/kvernon/realty-investor-timeline/compare/v1.0.1...v1.0.2) (2021-09-27)
 
-
 ### Bug Fixes
 
-* access public ([53e595b](https://github.com/kvernon/realty-investor-timeline/commit/53e595ba719f0116a4edafec415292e1e4c83596))
+- access public ([53e595b](https://github.com/kvernon/realty-investor-timeline/commit/53e595ba719f0116a4edafec415292e1e4c83596))
 
 ## [1.0.1](https://github.com/kvernon/realty-investor-timeline/compare/v1.0.0...v1.0.1) (2021-09-27)
 
-
 ### Bug Fixes
 
-* added dependency ([c755978](https://github.com/kvernon/realty-investor-timeline/commit/c7559789d6f8ba7b2dba3ceff0da88b3fe9d8891))
-* updating to publish; removed github release ([8fab8df](https://github.com/kvernon/realty-investor-timeline/commit/8fab8dfd40cc67d91caa73c32289393daa97ee47))
+- added dependency ([c755978](https://github.com/kvernon/realty-investor-timeline/commit/c7559789d6f8ba7b2dba3ceff0da88b3fe9d8891))
+- updating to publish; removed github release ([8fab8df](https://github.com/kvernon/realty-investor-timeline/commit/8fab8dfd40cc67d91caa73c32289393daa97ee47))

docs/_media/badge.svg

@@ -0,0 +1,11 @@
+[**@cubedelement.com/realty-investor-timeline**](../../index.md)
+
+---
+
+[@cubedelement.com/realty-investor-timeline](../../modules.md) / account/i-user-goal
+
+# account/i-user-goal
+
+## Interfaces
+
+- [IUserGoal](interfaces/IUserGoal.md)

docs/account/i-user-goal/index.md

@@ -0,0 +1,47 @@
+[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
+
+---
+
+[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [account/i-user-goal](../index.md) / IUserGoal
+
+# Interface: IUserGoal
+
+Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L3)
+
+## Extended by
+
+- [`IUserInvestorCheck`](../../i-user-investor-check/interfaces/IUserInvestorCheck.md)
+
+## Properties
+
+### monthlyIncomeAmountGoal
+
+> **monthlyIncomeAmountGoal**: `number`
+
+Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L7)
+
+used to determine how much you need want for monthly expenses
+
+## Methods
+
+### metMonthlyGoal()
+
+> **metMonthlyGoal**(`today`, `properties`): `boolean`
+
+Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/604db9c08bd36b2a48c8b342796ed6cd0d1401e0/src/account/i-user-goal.ts#L13)
+
+method used to help determine if you have met your expenses
+
+#### Parameters
+
+##### today
+
+`Date`
+
+##### properties
+
+[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
+
+#### Returns
+
+`boolean`

docs/account/i-user-goal/interfaces/IUserGoal.md

@@ -0,0 +1,11 @@
+[**@cubedelement.com/realty-investor-timeline**](../../index.md)
+
+---
+
+[@cubedelement.com/realty-investor-timeline](../../modules.md) / account/i-user-investor-check
+
+# account/i-user-investor-check
+
+## Interfaces
+
+- [IUserInvestorCheck](interfaces/IUserInvestorCheck.md)