diff --git a/README.md b/README.md index e71c9bd0..e9e5f1b2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,22 @@ # WideDomain -This is an experimental app / library for writing estimation functions in ReasonML. +This is an experimental library & application for writing estimation functions in ReasonML. -Currently it just has one very simple model for EA Funds over time. +Users would write models with declared interfaces (inputs & outputs). These models can output probability distributions or variables. + +## DistPlus +We have a custom library called DistPlus to handle distributions with additional metadata. This helps handle mixed distributions (continuous + discrete), a cache for a cdf, possible unit types (specific times are supported), and limited domains. + +## Running + +Currently it only has a few very simple models. ``` yarn yarn run start yarn run parcel ``` + +## Current Setup +You can see a current version of this running online here: +https://www.highlyspeculativeestimates.com/m/ea-funds