Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
helgee committed Feb 19, 2018
1 parent a6523b6 commit 5009f31
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Expand Up @@ -4,7 +4,8 @@

[![Build Status Unix][travis-badge]][travis-url] [![Build Status Windows][av-badge]][av-url] [![Coveralls][coveralls-badge]][coveralls-url] [![Codecov][codecov-badge]][codecov-url] [![Docs Stable][docs-badge-stable]][docs-url-stable] [![Docs Latest][docs-badge-latest]][docs-url-latest]

*ItemGraphs* is a simple wrapper around [LightGraphs](https://github.com/JuliaGraphs/LightGraphs.jl) that enables my most common use case for graph-like data structures:
**ItemGraphs** is a simple wrapper around [LightGraphs](https://github.com/JuliaGraphs/LightGraphs.jl) that enables my most common
use case for graph-like data structures:
I have a collection of items that are in relations between each other and I want to get the shortest path between two items. That's it!

## Installation
Expand Down Expand Up @@ -48,6 +49,6 @@ information.
[codecov-badge]: http://codecov.io/github/helgee/ItemGraphs.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/helgee/ItemGraphs.jl?branch=master
[docs-badge-latest]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-url-latest]: https://juliaastro.github.io/ItemGraphs.jl/latest
[docs-url-latest]: https://helgee.github.io/ItemGraphs.jl/latest
[docs-badge-stable]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-url-stable]: https://juliaastro.github.io/ItemGraphs.jl/stable
[docs-url-stable]: https://helgee.github.io/ItemGraphs.jl/stable
2 changes: 1 addition & 1 deletion docs/src/index.md
Expand Up @@ -2,7 +2,7 @@

*Shortest paths between items*

*ItemGraphs* is a simple wrapper around [LightGraphs](https://github.com/JuliaGraphs/LightGraphs.jl) that enables my most common use case for graph-like data structures:
**ItemGraphs** is a simple wrapper around [LightGraphs](https://github.com/JuliaGraphs/LightGraphs.jl) that enables my most common use case for graph-like data structures:
I have a collection of items that are in relations between each other and I want to get the shortest path between two items. That's it!

## Installation
Expand Down

0 comments on commit 5009f31

Please sign in to comment.