Update README.md

dkoslicki · Jan 12, 2024 · ef14495 · ef14495
1 parent 59cee69
commit ef14495
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
 # CMash
+
+# Please Note: CMash has largely been supplanted by [Sourmash](https://github.com/sourmash-bio/sourmash). While Sourmash technically does not possess the ability to change k-mer sizes, we have decided to adopt Sourmash and incorporate our other results (eg. estimating ANI and AAI) into the Sourmash code base. Consider this repo depreciated.
+
 CMash is a fast and accurate way to estimate the similarity of two sets. This is a probabilisitic data analysis approach, and uses containment min hashing. Please see the [associated paper]( https://doi.org/10.1101/2021.12.06.471436) for further details (and please cite if you use it):
 ```
 Liu, S., & Koslicki, D. (2021). CMash: fast, multi-resolution estimation of k-mer-based Jaccard and containment indices. bioRxiv.  https://doi.org/10.1101/2021.12.06.471436