Add benchmarks to README.md

Author: simonschoelly

README.md

@@ -1,19 +1,25 @@
 # SimpleValueGraphs.jl
 
-[![version](https://juliahub.com/docs/SimpleValueGraphs/version.svg)](https://juliahub.com/ui/Packages/SimpleValueGraphs/aub6U)
 ![](https://img.shields.io/badge/lifecycle-maturing-blue.svg)
+[![version](https://juliahub.com/docs/SimpleValueGraphs/version.svg)](https://juliahub.com/ui/Packages/SimpleValueGraphs/aub6U)
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://simonschoelly.github.io/SimpleValueGraphs.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://simonschoelly.github.io/SimpleValueGraphs.jl/dev)
-[![Build Status](https://travis-ci.com/simonschoelly/SimpleValueGraphs.jl.svg?branch=master)](https://travis-ci.com/simonschoelly/SimpleValueGraphs.jl)
 ![CI](https://github.com/simonschoelly/SimpleValueGraphs.jl/workflows/CI/badge.svg?branch=master)
 [![codecov](https://codecov.io/gh/simonschoelly/SimpleValueGraphs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/simonschoelly/SimpleValueGraphs.jl)
 [![](https://img.shields.io/badge/chat-Zulip%23graphs-yellow)](https://julialang.zulipchat.com/#narrow/stream/228745-graphs)
 
-This is a experimental package that uses the interface from [LightGraphs.jl](https://github.com/JuliaGraphs/LightGraphs.jl).
-It is similar to [MetaGraphs.jl](https://github.com/JuliaGraphs/MetaGraphs.jl) and [SimpleWeightedGraphs.jl](https://github.com/JuliaGraphs/SimpleWeightedGraphs.jl).
-It solves the following problem:
-- The topology of `MetaGraphs` can be changed fast, but changing and querying edge values is slow.
-- Changing the topology of `SimpleWeightedGraphs` is slow, but changing and querying edge values is fast.
+This is [LightGraphs.jl](https://github.com/JuliaGraphs/LightGraphs.jl) compatible package for graphs with multiple, homogeneous vertex and edge metadata. In particular it provides:
+- an abstract interface for graphs with metadata
+- concrete implementations of mutable graphs with metadata
+
+Compared to [SimpleWeightedGraphs.jl](https://github.com/JuliaGraphs/SimpleWeightedGraphs.jl) it has the following advantages:
+- vertex metadata
+- multiple edge metadata
+- faster structural modifications of graphs
+
+Compared to [MetaGraphs.jl](https://github.com/JuliaGraphs/MetaGraphs.jl) it has the following advantages:
+- faster access and modifications of metadata
+- better type stability when accessing metadata
 
 ## Example
 
@@ -50,3 +56,15 @@ graphplot(gv;
 ```
 ![example output](https://github.com/simonschoelly/SimpleValueGraphs.jl/blob/master/docs/assets/readme-example-output.png)
 
+## Benchmarks
+
+This is a comparison of running `LightGraphs.dijkstra_shortest_paths` on the [egonets-Facebook](https://snap.stanford.edu/data/egonets-Facebook.html) graph for multiple graph types - one should note, that this function is not optimal when accessing the edge weights for most of these graph types, so in the future these benchmarks should be repeated with a more optimized function.
+
+| graph type                                        | time (ms) |
+| ------------------------------------------------- | --------- |
+| LightGraphs.SimpleGraph + Matrix weights          | 5.1       |
+| LightGraphs.SimpleGraph + SparseMatrixCSC weights | 7.9       |
+| SimpleWeightedGraphs.SimpleWeightedGraph          | 7.8       |
+| MetaGraphs.MetaGraph                              | 68.5      |
+| SimpleValueGraphs.ValGraph                        | 9.2       |
+