diff --git a/README.md b/README.md
index c32939d..b419f23 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,6 @@
 # DifferentiableFlatten
+
+[![Actions Status](https://github.com/JuliaNonconvex/DifferentiableFlatten.jl/workflows/CI/badge.svg)](https://github.com/JuliaNonconvex/DifferentiableFlatten.jl/actions)
+[![codecov](https://codecov.io/gh/JuliaNonconvex/DifferentiableFlatten.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaNonconvex/DifferentiableFlatten.jl)
+
+This package includes an implementation of a `flatten` function which flattens all data structures to vectors and returns an unflattenning function to back to the original data structure. This was originally part of [NonconvexCore.jl](https://github.com/JuliaNonconvex/NonconvexCore.jl).