Merge pull request #2 from SciML/ChrisRackauckas-patch-1

Add some README
SciML · Jan 25, 2024 · bc286f8 · bc286f8
2 parents 3d3e332 + 68e15ec
commit bc286f8
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,10 @@
 # FindFirstFunctions
 
 [![Build Status](https://github.com/SciML/FindFirstFunctions.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SciML/FindFirstFunctions.jl/actions/workflows/CI.yml?query=branch%3Amain)
+
+FindFirstFunctions.jl is a package for faster `findfirst` type functions. These are specailized to improve performance
+over more generic implementations.
+
+## Functions
+
+* `findfirstequal(x::Int64,A::DenseVector{Int64})`: finds the first value in `A` equal to `x`