commit 19d69dc29769075db28a330c372d64c73bd8e262
parent 6074f0b0942a70426e0b3e9a854ad910a523a585
Author: Jacob R. Edwards <jacob@jacobedwards.org>
Date: Sun, 27 Oct 2024 22:00:49 -0700
Add README with a bit more information on the project
Diffstat:
| A | README | | | 29 | +++++++++++++++++++++++++++++ |
1 file changed, 29 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,29 @@
+A few small utilities to help with asset allocation
+
+These scripts accept data in the form
+
+ symbol number
+
+where `symbol' identifies the asset (for example a stock market
+ticker symbol) and `number' means different things depending on
+which script is interpreting it: In the case of `alloc' it is a
+percentage of your portfolio you want to allocate to that asset,
+and in the case of `er' it is the expense ratio of the asset.
+
+The scripts likely have the most recent usage information, but
+here's a (hard to follow) example of how you might use these tools
+to allocate $8,000 between four different funds (VTI, VWO, VPL, and
+VGK) with 70% going to the first fund and 10% going to each other
+using alloc:
+
+ $ echo '# Allocation percentages
+VTI 70
+VWO 10
+VPL 10
+VGK 10' > input
+
+ $ alloc 8000 < input
+ VTI 5600
+ VWO 800
+ VPL 800
+ VGK 800
