Update README

Author: adrhill

README.md

@@ -4,3 +4,39 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Julia-XAI.github.io/TextHeatmaps.jl/dev/)
 [![Build Status](https://github.com/Julia-XAI/TextHeatmaps.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Julia-XAI/TextHeatmaps.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/Julia-XAI/TextHeatmaps.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Julia-XAI/TextHeatmaps.jl)
+
+TextHeatmaps.jl is a lightweight Julia package for visualization of numerical values associated with text.
+
+## Installation
+To install this package and its dependencies, open the Julia REPL and run
+
+```julia-repl
+]add TextHeatmaps
+```
+
+## Example
+Assume you have the following values associated with words in a sentence:
+```julia
+text = "I loved the concert but not the opening act"
+words = split(text)
+val = [0.1, 2.5, 0.0, 0.3, -0.6, -1.4, 0.0, 0.1, -0.1]
+```
+
+These values could for example come from a sentiment analysis model.
+
+Using the heatmap function, we can visualize the values:
+
+![Heatmap in Julia-REPL][heatmap-repl]
+
+This not only works in the REPL, but also works in Pluto notebooks and Documenter:
+
+![Heatmap in Pluto][heatmap-pluto]
+
+The color scheme of the `heatmap` can be customized, as shown in the 
+[package documentation](https://Julia-XAI.github.io/TextHeatmaps.jl/stable/):
+
+![Heatmap in Documenter][heatmap-settings]
+
+[heatmap-repl]: https://raw.githubusercontent.com/Julia-XAI/TextHeatmaps.jl/gh-pages/assets/heatmap_repl.png
+[heatmap-pluto]: https://raw.githubusercontent.com/Julia-XAI/TextHeatmaps.jl/gh-pages/assets/heatmap_pluto.png
+[heatmap-settings]: https://raw.githubusercontent.com/Julia-XAI/TextHeatmaps.jl/gh-pages/assets/heatmap_settings.png

docs/src/example.md

@@ -9,7 +9,7 @@ The model returns a vector of sentiment scores for each word,
 where positive values indicate positive sentiment 
 and negative values indicate negative sentiment:
 ```@example 1;
-val = [0.1, 2.5, 0.0, 0.3, -0.6, -1.4, 0.0, 0.1, -0.3]
+val = [0.1, 2.5, 0.0, 0.3, -0.6, -1.4, 0.0, 0.1, -0.1]
 nothing #hide
 ```