Update README.md

README.md

@@ -1,3 +1,21 @@
-# FractalIntegrals [![Build Status](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/)
+# FractalIntegrals.jl [![Build Status](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AndrewGibbs/FractalIntegrals.jl/actions/workflows/CI.yml?query=branch%3Amain) [![codecov](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl/graph/badge.svg?token=Z3JPZANMW5)](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl) [![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/)
+<img src="https://github.com/AndrewGibbs/FractalIntegrals.jl/blob/main/docs/src/assets/logo.png" alt="description" style="width: 25%;">
 
-The rewrite of [IFSintegrals](https://github.com/AndrewGibbs/IFSintegrals)...
+`FractalIntegrals` is a library of methods and structures for evaluating integrals and solving integral equations posed on fractals. It is a rewrite of [IFSintegrals](https://github.com/AndrewGibbs/IFSintegrals).
+
+## Installation
+
+As an official Julia package, `FractalIntegrals` can be installed via the Julia package manager:
+
+```
+using Pkg
+Pkg.install("FractalIntegrals")
+```
+
+## Documentation and examples
+
+The current documentation can be found [here](https://andrewgibbs.github.io/FractalIntegrals.jl/dev/). Please note that the documentation is still being written. A better introduction might be the example codes; there are several available [in this repo](https://github.com/AndrewGibbs/FractalIntegrals.jl/tree/main/examples), written in [Jupyter notebook](https://jupyter.org) and [Pluto](https://plutojl.org) formats.
+
+## Coverage
+
+![Coverage](https://codecov.io/gh/AndrewGibbs/FractalIntegrals.jl/graphs/icicle.svg?token=Z3JPZANMW5)