Skip to content

Commit

Permalink
docs(README): rearrange & add guide (#210)
Browse files Browse the repository at this point in the history
  • Loading branch information
TWT233 committed May 28, 2023
1 parent dabf209 commit 25d26b4
Showing 1 changed file with 14 additions and 23 deletions.
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,9 @@
[![khl server](https://www.kaiheila.cn/api/v3/badge/guild?guild_id=7236941486257903&style=3)](https://kaihei.co/JJE0Es)
![github stars](https://img.shields.io/github/stars/TWT233/khl.py?style=social)

Python SDK for [kaiheila.cn](https://www.kaiheila.cn/) API
Python SDK for [kookapp.cn](https://www.kookapp.cn/)(aka [kaiheila.cn](https://www.kaiheila.cn/)) API

# install

Python requirement: >= Python 3.6

```shell
pip install khl.py
```

# quickly enroll

Minimal example:
# Minimal Example

```python
from khl import Bot, Message
Expand All @@ -39,25 +29,26 @@ bot.run()
# (remember to grant the bot with read & send permissions)
```

For more example and tutorial, please turn to [example](./example)
# INSTALL

# FAQ
requirement: Python >= 3.6.8

when question encountered during using khl.py,
please refer to [our wiki](https://github.com/TWT233/khl.py/wiki) for FAQ set
```shell
pip install khl.py
```

# Documentation

- [Guide](https://khl-py.eu.org/) (authored by [musnows](https://github.com/musnows))
- [Example](./example)
- [Wiki](https://github.com/TWT233/khl.py/wiki) (archived FAQ)

if your question has not been listed yet, please [create a issue](https://github.com/TWT233/khl.py/issues/new/choose)
or [join our talk channel](https://kaihei.co/JJE0Es) for help

# CONTRIBUTION
# CONTRIBUTING

welcome! we are glad to get help from community hands, and don't be shy to show your code,
we can improve it together even if it's not perfect right now

if there is any bug/perf/feature request, we are willing to deal with your issue/pull request!

the only red tape:

only accept commits satisfying [Conventional Commits convention](https://github.com/commitizen/cz-cli)

search plugins with keyword `commitizen` for your editor/IDE, then addict to write commit message

0 comments on commit 25d26b4

Please sign in to comment.