diff --git a/README.md b/README.md index d1516139..822d71ab 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ -# ![graaf](docs/img/graaf.png) Graaf -[![Main-CI](https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml/badge.svg)](https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml) -[![codecov](https://codecov.io/github/bobluppes/graaf/branch/main/graph/badge.svg?token=ZFBLNFN39C)](https://codecov.io/github/bobluppes/graaf) -[![Documentation](https://img.shields.io/badge/documentation-doxygen-informational)](https://bobluppes.github.io/graaf/) -[![License](https://img.shields.io/badge/license-MIT-black)](LICENSE.md) +
+

+ + raaf Lib +

-Graaf is a general-purpose lightweight C++ library designed for versatile graph operations. Graaf allows users to easily create, modify, and query graphs. It is well-suited for various graph-based applications, including social network analysis, CNNs, and more. +
-## Features + +

+ Graaf is a general-purpose lightweight C++ library designed for versatile graph operations. Graaf allows users to easily create, modify, and query graphs. It is well-suited for various graph-based applications, including social network analysis, CNNs, and more. +

+ + + [![Main-CI](https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml/badge.svg)](https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml) + [![codecov](https://codecov.io/github/bobluppes/graaf/branch/main/graph/badge.svg?token=ZFBLNFN39C)](https://codecov.io/github/bobluppes/graaf) + [![Documentation](https://img.shields.io/badge/documentation-doxygen-informational)](https://bobluppes.github.io/graaf/) + [![License](https://img.shields.io/badge/license-MIT-black)](LICENSE.md) + +
+ +# Features The Graaf library is designed with generality in mind. As such, it comes with specializations for a `directed_graph` as well as an `undirected_graph`. Furthermore, it can be used to store user-defined vertex and edge classes: ```c++