Skip to content

Commit b947ee6

Browse files
Add installation instructions and PyPi badge to README.md
1 parent 9371bc5 commit b947ee6

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![CodeQL](https://github.com/Electronic-Mango/reddit-python-api/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Electronic-Mango/reddit-api-api/actions/workflows/codeql-analysis.yml)
44
[![Black](https://github.com/Electronic-Mango/reddit-python-api/actions/workflows/black.yml/badge.svg)](https://github.com/Electronic-Mango/reddit-api-api/actions/workflows/black.yml)
55
[![Flake8](https://github.com/Electronic-Mango/reddit-python-api/actions/workflows/flake8.yml/badge.svg)](https://github.com/Electronic-Mango/reddit-api-api/actions/workflows/flake8.yml)
6+
[![PyPI version](https://badge.fury.io/py/reddit-python-api.svg)](https://badge.fury.io/py/reddit-python-api)
67

78
A simple Reddit Python API allowing accessing both subreddit and user submissions, build with [`httpx`](https://www.python-httpx.org/).
89

@@ -12,6 +13,7 @@ A simple Reddit Python API allowing accessing both subreddit and user submission
1213

1314
* [Table of contents](#table-of-contents)
1415
* [Introduction and requirements](#introduction-and-requirements)
16+
* [Installation](#installation)
1517
* [Reddit app & configuration](#reddit-app--configuration)
1618
* [Usage](#usage)
1719
* [Create the API](#create-the-api)
@@ -41,6 +43,15 @@ It doesn't access comments.
4143

4244

4345

46+
## Installation
47+
48+
Project is available in [PyPi](https://pypi.org/project/reddit-python-api/):
49+
```bash
50+
pip install reddit-python-api
51+
```
52+
53+
54+
4455
## Reddit app & configuration
4556

4657
In order to use this API you need to create a Reddit app at https://old.reddit.com/prefs/apps/.

0 commit comments

Comments
 (0)