Skip to content

Commit a3c39fa

Browse files
committed
add badges
1 parent 08394e3 commit a3c39fa

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,22 @@
55

66
Compartmental Epidemic Models in Python
77

8+
![GitHub Release](https://img.shields.io/github/v/release/DataForScience/epidemik)
9+
![GitHub followers](https://img.shields.io/github/followers/DataForScience)
10+
![GitHub forks](https://img.shields.io/github/forks/DataForScience/epidemik)
11+
![GitHub Repo stars](https://img.shields.io/github/stars/DataForScience/epidemik)
12+
![GitHub License](https://img.shields.io/github/license/DataForScience/epidemik)
13+
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/DataForScience/epidemik)
14+
![GitHub last commit](https://img.shields.io/github/last-commit/DataForScience/epidemik)
15+
816

917
---
1018

1119
## Table of contents[![](https://raw.githubusercontent.com/DataForScience/epidemik/main/images/pin.svg)](#toc)
1220
- [Installation](#installation)
1321
- [Tech Stack](#tech)
14-
- [Usage](#usage)
22+
- [Basic Usage](#usage)
23+
- [Documentation](#documentation)
1524
- [Contributing](#contributing)
1625
- [License](#license)
1726

@@ -46,7 +55,7 @@ Here's a brief high-level overview of the tech stack the `epidemik` package uses
4655
---
4756

4857

49-
## Usage[![](https://raw.githubusercontent.com/DataForScience/epidemik/main/images/pin.svg)](#usage)
58+
## Basic Usage[![](https://raw.githubusercontent.com/DataForScience/epidemik/main/images/pin.svg)](#usage)
5059

5160
`epidemik` provides three main modules, `EpiModel`, `NetworkEpiModel` and `MetaEpiModel`, usually imported directly from the `epidemik` package using the module name
5261

@@ -123,6 +132,15 @@ which produces:
123132

124133
---
125134

135+
136+
## Documentation[![](https://raw.githubusercontent.com/DataForScience/epidemik/main/images/pin.svg)](#documentation)
137+
138+
The full documentation for this project is available at ReadTheDocs in [html](https://epidemik.readthedocs.io/), [PDF](https://epidemik.readthedocs.io/_/downloads/en/latest/pdf/) and [ePub](https://epidemik.readthedocs.io/_/downloads/en/latest/epub/) formats.
139+
140+
<div align="right">[ <a href="#table-of-contents">↑ Back to top ↑</a> ]</div>
141+
142+
---
143+
126144
## Contributing[![](https://raw.githubusercontent.com/DataForScience/epidemik/main/images/pin.svg)](#contributing)
127145

128146
Pull requests are welcome. For major changes, please open an issue first

0 commit comments

Comments
 (0)