Skip to content

Commit db80db2

Browse files
authored
docs: Changes to docs and fix long description content type (nextcord#9)
1 parent 8601a7e commit db80db2

File tree

7 files changed

+39
-27
lines changed

7 files changed

+39
-27
lines changed

.github/workflows/analyze.yml

+4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ name: Analyze
22

33
on:
44
pull_request:
5+
branches:
6+
- master
57
push:
8+
branches:
9+
- master
610
schedule:
711
- cron: "0 0 * * 0"
812

.github/workflows/build.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: Build
22

3-
on: [pull_request, push]
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
410

511
jobs:
612
job:

.github/workflows/lint.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: Lint
22

3-
on: [pull_request, push]
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
410

511
jobs:
612
job:

README.md

+15-20
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
11
# nextcord-ext-ipc
22

3-
<p style="text-align: center">
4-
<a href="https://github.com/nextcord/nextcord-ext-ipc/actions?query=workflow%3AAnalyze+event%3Apush">
5-
<img alt="Analyze Status"
6-
src="https://github.com/nextcord/nextcord-ext-ipc/workflows/Analyze/badge.svg?event=push" />
7-
</a>
8-
<a href="https://github.com/nextcord/nextcord-ext-ipc/actions?query=workflow%3ABuild+event%3Apush">
9-
<img alt="Build Status"
10-
src="https://github.com/nextcord/nextcord-ext-ipc/workflows/Build/badge.svg?event=push" />
11-
</a>
12-
<a href="https://github.com/nextcord/nextcord-ext-ipc/actions?query=workflow%3ADeploy+event%3Apush">
13-
<img alt="Deploy Status"
14-
src="https://github.com/nextcord/nextcord-ext-ipc/workflows/Deploy/badge.svg?event=push" />
15-
</a>
16-
<a href="https://github.com/Ext-Creators/nextcord-ext-ipc/actions?query=workflow%3ALint+event%3Apush">
17-
<img alt="Lint Status"
18-
src="https://github.com/nextcord/nextcord-ext-ipc/workflows/Lint/badge.svg?event=push" />
19-
</a>
20-
</p>
3+
[![Discord server invite](https://discord.com/api/guilds/881118111967883295/embed.png)](https://discord.gg/ZebatWssCB)
4+
[![PyPI version info](https://img.shields.io/pypi/v/nextcord-ext-ipc.svg)](https://pypi.python.org/pypi/nextcord-ext-ipc)
5+
[![Analyze Status](https://github.com/nextcord/nextcord-ext-ipc/workflows/Analyze/badge.svg?event=push)](https://github.com/nextcord/nextcord-ext-ipc/actions?query=workflow%3AAnalyze+event%3Apush)
6+
[![Build Status](https://github.com/nextcord/nextcord-ext-ipc/workflows/Build/badge.svg?event=push)](https://github.com/nextcord/nextcord-ext-ipc/actions?query=workflow%3ABuild+event%3Apush)
7+
[![Lint Status](https://github.com/nextcord/nextcord-ext-ipc/workflows/Lint/badge.svg?event=push)](https://github.com/Ext-Creators/nextcord-ext-ipc/actions?query=workflow%3ALint+event%3Apush)
218

229
## About
2310

2411
A Nextcord extension for inter-process communication.
2512

2613
## Installation
2714

28-
Python **>=3.6.0** is required.
15+
**Python 3.8 or higher is required**
16+
17+
It is necessary to first install [Nextcord](https://github.com/nextcord/nextcord)
18+
19+
Then install the extension by running one of the following commands:
2920

3021
```py
31-
pip install --upgrade nextcord-ext-ipc
22+
# Linux/macOS
23+
python3 -m pip install -U nextcord-ext-ipc
24+
25+
# Windows
26+
py -3 -m pip install -U nextcord-ext-ipc
3227
```
3328

3429
## Links

docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to discord-ext-ipc's documentation!
2-
===========================================
1+
Welcome to nextcord-ext-ipc's documentation!
2+
============================================
33

44
.. toctree::
55
:numbered:

nextcord/ext/ipc/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77

88
_VersionInfo = collections.namedtuple("_VersionInfo", "major minor micro release serial")
99

10-
version = "2.2.0"
11-
version_info = _VersionInfo(2, 2, 0, "final", 0)
10+
version = "2.2.1"
11+
version_info = _VersionInfo(2, 2, 1, "final", 0)

setup.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@
7878
author="Nextcord Developers",
7979
classifiers=classifiers,
8080
description="A Nextcord extension for inter-process communication.",
81+
long_description=long_description,
82+
long_description_content_type="text/markdown",
8183
extras_require=extras_require,
8284
install_requires=install_requires,
8385
license="Apache Software License",
@@ -87,5 +89,4 @@
8789
python_requires=">=3.6.0",
8890
url="https://github.com/nextcord/nextcord-ext-ipc",
8991
version=version,
90-
long_description=long_description,
9192
)

0 commit comments

Comments
 (0)