chore: add basic information to README

ait-energy · Jun 1, 2024 · ac69f21 · ac69f21
1 parent b7c7de0
commit ac69f21
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,6 @@
 [![Build Status](https://github.com/ait-energy/IESoptLib.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ait-energy/IESoptLib.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ait-energy/IESoptLib.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ait-energy/IESoptLib.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+
+This is a Julia package for the IESopt library. The IESopt library is a collection of `Template`s, `Addon`s, examples,
+and other assets that are included in [`IESopt.jl`](https://github.com/ait-energy/IESopt.jl).