Skip to content

Commit 01d4dac

Browse files
authored
Merge pull request #42 from JuliaGraphs/gd/metagraphsnext
Update README and CI
2 parents c5aa8e2 + e72d70d commit 01d4dac

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ name: CI
22
on:
33
push:
44
branches: [master]
5+
tags: '*'
56
pull_request:
67
types: [opened, synchronize, reopened]
78
jobs:

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
# MetaGraphs
22

3-
[![Build Status][build-img]][build-url]
4-
[![Codecov branch][codecov-img]][codecov-url]
5-
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliagraphs.org/MetaGraphs.jl/dev/)
3+
[![Stable docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliagraphs.org/MetaGraphs.jl/)
4+
[![Dev docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliagraphs.org/MetaGraphs.jl/dev/)
5+
[![Build Status](https://github.com/JuliaGraphs/Metagraphs.jl/workflows/CI/badge.svg?branch=master)](https://github.com/JuliaGraphs/Metagraphs.jl/actions?query=workflow%3ACI)
6+
[![Codecov](http://codecov.io/github/JuliaGraphs/Metagraphs.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaGraphs/Metagraphs.jl?branch=master)
67

7-
[MetaGraphs.jl](https://github.com/JuliaGraphs/MetaGraphs.jl) graphs with arbitrary metadata.
8+
A flexible package for graphs with arbitrary metadata.
89

9-
[build-img]: https://github.com/JuliaGraphs/Metagraphs.jl/workflows/CI/badge.svg?branch=master
10-
[build-url]: https://github.com/JuliaGraphs/Metagraphs.jl/actions?query=workflow%3ACI
11-
[codecov-img]: http://codecov.io/github/JuliaGraphs/Metagraphs.jl/coverage.svg?branch=master
12-
[codecov-url]: http://codecov.io/github/JuliaGraphs/Metagraphs.jl?branch=master
10+
> For a more performant option, check out [MetaGraphsNext.jl](https://github.com/JuliaGraphs/MetaGraphsNext.jl)
1311
14-
## Documentation
15-
Full documentation is available on the [JuliaGraphs site](https://juliagraphs.org/MetaGraphs.jl/dev/).
16-
Documentation for methods is also available via the Julia REPL help system.
12+
## Getting started
1713

18-
## Installation
1914
Installation is straightforward: from the Julia `pkg` prompt,
2015
```julia
21-
add MetaGraphs
16+
pkg> add MetaGraphs
2217
```
2318

24-
## Example Usage
19+
Full documentation is available [here](https://juliagraphs.org/MetaGraphs.jl/).
20+
Documentation for methods is also available via the Julia REPL help system.
21+
22+
## Example use
23+
2524
```julia
2625
julia> using Graphs, MetaGraphs
2726

0 commit comments

Comments
 (0)