Skip to content

Commit 25d26b4

Browse files
authored
docs(README): rearrange & add guide (#210)
1 parent dabf209 commit 25d26b4

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,9 @@
66
[![khl server](https://www.kaiheila.cn/api/v3/badge/guild?guild_id=7236941486257903&style=3)](https://kaihei.co/JJE0Es)
77
![github stars](https://img.shields.io/github/stars/TWT233/khl.py?style=social)
88

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

11-
# install
12-
13-
Python requirement: >= Python 3.6
14-
15-
```shell
16-
pip install khl.py
17-
```
18-
19-
# quickly enroll
20-
21-
Minimal example:
11+
# Minimal Example
2212

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

42-
For more example and tutorial, please turn to [example](./example)
32+
# INSTALL
4333

44-
# FAQ
34+
requirement: Python >= 3.6.8
4535

46-
when question encountered during using khl.py,
47-
please refer to [our wiki](https://github.com/TWT233/khl.py/wiki) for FAQ set
36+
```shell
37+
pip install khl.py
38+
```
39+
40+
# Documentation
41+
42+
- [Guide](https://khl-py.eu.org/) (authored by [musnows](https://github.com/musnows))
43+
- [Example](./example)
44+
- [Wiki](https://github.com/TWT233/khl.py/wiki) (archived FAQ)
4845

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

52-
# CONTRIBUTION
49+
# CONTRIBUTING
5350

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

5754
if there is any bug/perf/feature request, we are willing to deal with your issue/pull request!
58-
59-
the only red tape:
60-
61-
only accept commits satisfying [Conventional Commits convention](https://github.com/commitizen/cz-cli)
62-
63-
search plugins with keyword `commitizen` for your editor/IDE, then addict to write commit message

0 commit comments

Comments
 (0)