Skip to content

Commit 9a691b3

Browse files
author
Nekokatt
committed
Merge branch 'task/update-readme'
2 parents 9f669c5 + e90e432 commit 9a691b3

3 files changed

Lines changed: 23 additions & 9 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
**Note:** this API is still under active daily development, and is in a
2-
**alpha** stage. If you are looking to give feedback, or want to help us
3-
out, then feel free to join our [Discord server](https://discord.gg/Jx4cNGG) and
4-
chat to us. Any help is greatly appreciated, no matter what your experience
5-
level may be! :-)
1+
[![hikarivers](https://img.shields.io/pypi/v/hikari)](https://pypi.org/project/hikari)
2+
[![pyvers](https://img.shields.io/pypi/pyversions/hikari)](https://pypi.org/project/hikari)
3+
[![codecov](https://img.shields.io/codecov/c/github/nekokatt/hikari)](https://codecov.io/gh/nekokatt/hikari)
4+
[![prs](https://img.shields.io/github/issues-pr/nekokatt/hikari)](https://github.com/nekokatt/hikari/pulls)
5+
[![issues](https://img.shields.io/github/issues-raw/nekokatt/hikari)](https://github.com/nekokatt/hikari/issues)
6+
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://pypi.org/project/black/)
7+
[![mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://pypi.org/project/mypy/)
68

7-
---
9+
[![Discord](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner2)](https://discord.gg/Jx4cNGG)
810

911
# _hikari_
1012

@@ -81,3 +83,11 @@ to get started.
8183

8284
Once this is complete, you can run `nox` without any arguments to ensure
8385
everything builds and is correct.
86+
87+
### Where can I start?
88+
89+
Check out the issues tab on GitHub. If you are nervous, look for issues
90+
marked as ![good-first-issue-badge](https://img.shields.io/github/labels/nekokatt/hikari/good%20first%20issue) for
91+
something easy to start with!
92+
93+
[![good-first-issues](https://img.shields.io/github/issues/nekokatt/hikari/good%20first%20issue)](https://github.com/nekokatt/hikari/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)

hikari/_about.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@
2727
__author__ = "Nekokatt"
2828
__ci__ = "https://travis-ci.org/github/nekokatt/hikari"
2929
__copyright__ = "© 2020 Nekokatt"
30+
__coverage__ = "https://codecov.io/gh/nekokatt/hikari"
3031
__discord_invite__ = "https://discord.gg/Jx4cNGG"
3132
__docs__ = "https://nekokatt.github.io/hikari"
3233
__email__ = "nekoka.tt@outlook.com"
3334
__issue_tracker__ = "https://github.com/nekokatt/hikari/issues"
3435
__license__ = "MIT"
3536
__url__ = "https://github.com/nekokatt/hikari"
37+
__url_mirror__ = "https://gitlab.com/nekokatt/hikari"
3638
__version__ = "2.0.0"
3739
__git_sha1__ = "HEAD"

setup.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,12 @@ def parse_requirements_file(path):
6868
url=metadata.url,
6969
project_urls={
7070
"Documentation": metadata.docs,
71-
"Source": metadata.url,
72-
"CI": metadata.ci,
73-
"Tracker": metadata.issue_tracker,
71+
"Source (GitHub)": metadata.url,
7472
"Discord": metadata.discord_invite,
73+
"Issue Tracker": metadata.issue_tracker,
74+
"CI": metadata.ci,
75+
"Codecov": metadata.mirror_url,
76+
"Source (GitLab mirror)": metadata.mirror_url,
7577
},
7678
packages=setuptools.find_namespace_packages(include=[name + "*"]),
7779
python_requires=">=3.8.0,<3.10",

0 commit comments

Comments
 (0)