From 2ae25f981f754dcce2545b10be6f6b02c18ac492 Mon Sep 17 00:00:00 2001 From: RohitRathore1 Date: Tue, 27 Jul 2021 16:02:03 +0530 Subject: [PATCH] update README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f4c5914..c467796 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ # TopOptProblems + +[![Actions Status](https://github.com/juliatopopt/TopOptProblems.jl/workflows/CI/badge.svg)](https://github.com/juliatopopt/TopOptProblems.jl/actions) +[![codecov](https://codecov.io/gh/juliatopopt/TopOptProblems.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/juliatopopt/TopOptProblems.jl) + +`TopOptProblems` is a collection of standard topology optimisation problems package written in [Julia](https://github.com/JuliaLang/julia). + +## Installation + +To install `TopOptProblems.jl`, run: + +```julia +using Pkg +pkg"add TopOptProblems" +``` + +To load the package, use: + +```julia +using TopOptProblems +```