Readme and doc update.

Digithought · Feb 28, 2024 · 0c30c41 · 0c30c41
1 parent 9224641
commit 0c30c41
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 35 deletions.
diff --git a/docs/classes/Sparstogram.html b/docs/classes/Sparstogram.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Centroid.html b/docs/interfaces/Centroid.html
diff --git a/docs/interfaces/Peak.html b/docs/interfaces/Peak.html
diff --git a/docs/interfaces/Quantile.html b/docs/interfaces/Quantile.html
diff --git a/readme.md b/readme.md
@@ -1,8 +1,8 @@
 # Sparstogram Library
 
-Sparse, adaptive, scalable histogram in TypeScript
+Sparse/dense, adaptive, scalable histogram in TypeScript.  [On GitHub](https://github.com/Digithought/Sparstogram).
 
-This Typescript library provides a sophisticated data structure for efficiently characterizing large datasets through histograms.
+This Typescript library provides a sophisticated data structure for efficiently characterizing datasets through histograms.
 
 ## Summary
 
@@ -22,6 +22,7 @@ The implementation uses B+Trees to efficiently maintain the centroids and losses
 * Quantile information includes the centroid, variance, count, rank, and offset within bucket
 * Can compute local maxima ("peaks") with average window smoothing
 * Directional iteration of centroids from the ends, a marker, a value, or by loss
+* Scalable - uses in-memory B+Trees ([Digitree](https://github.com/Digithought/Digitree)) which are fast and balanced
 
 ### Why programmers need histograms
 
@@ -52,7 +53,9 @@ Or, if you prefer using `pnpm`:
 pnpm add sparstogram
 ```
 
-## Usage Examples
+## Usage
+
+#### [Reference Documentation](https://digithought.github.io/Sparstogram/)
 
 ### Creating a Sparstogram