Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lerdb committed Feb 3, 2024
1 parent bdd4982 commit 0997464
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 10 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
简体中文 | [English](README_EN.md)

<div align="center">

![lx-music-api-server-python](https://socialify.git.ci/lxmusics/lx-music-api-server-python/image?description=1&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Auto)
Expand All @@ -15,7 +17,22 @@

由于使用此项目导致的**封号**等情况**与本项目无关**

## 部署方法
## 💡特点

- [ ] 功能
- [ ] 完整性API(歌单,搜索)
- [ ] 网易云刷新登录
- [ ] 服务器向webdav
- [ ] 客户端播放服务器上的本地音乐
- [x] Cookie池
- [x] https监听,多端口监听
- [x] 反代兼容性
- [x] 获取更高的音质
- [x] QRC解密
- [ ] 本地化支持(目前仅支持简体中文)
- [x] 多端部署(`Windows` `Linux` `MacOS`

## 💻部署方法

### Release 部署(推荐)

Expand Down Expand Up @@ -120,7 +137,7 @@ linux 命令如果为 python3 请自行替换

5. 到容器目录里的 `/app` 目录填写 `config.json`

## 返回码说明
## 📖返回码说明

接口返回值中`body.code`字段值中的代码含义

Expand All @@ -143,7 +160,7 @@ linux 命令如果为 python3 请自行替换
| 429 | 请求过于频繁 |
| 500 | 服务器内部错误(对应 body.code 4) |

## 备注
## 🔖备注

### 本项目中可能会出现以下优秀代码

Expand Down Expand Up @@ -239,7 +256,7 @@ linux 命令如果为 python3 请自行替换
f = e(c, b, a)
```

## 项目协议
## 📄项目协议

本项目基于 [MIT](https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE) 许可证发行,以下协议是对于 MIT 原协议的补充,如有冲突,以以下协议为准。

Expand Down
29 changes: 23 additions & 6 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
English | [简体中文](README.md)

<div align="center">

![lx-music-api-server-python](https://socialify.git.ci/lxmusics/lx-music-api-server-python/image?description=1&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Auto)
Expand All @@ -15,7 +17,22 @@ You can find the corresponding available source scripts in the original reposito

**Ban** and other situations caused by the use of this project have **nothing** to do with this project.

## How to deploy
## 💡Feature

- [ ] Functions
- [ ] All APIs (playlist, search)
- [ ] Netease Cloud Refresh Login
- [ ] Client plays music on webdav
- [ ] Client plays local music on the server
- [x] Cookie pool
- [x] HTTPS listening, multi port listening
- [x] Supports reverse compatibility
- [x] Get higher quality
- [x] QRC decrypt
- [ ] Localization (currently only Simplified Chinese is supported)
- [x] Platform support: `Windows` `Linux` `MacOS`

## 💻How to deploy

### Use Release (recommended)

Expand Down Expand Up @@ -118,7 +135,7 @@ This method **has not been tested**, and we don't know the required Docker versi

5. Go to the `/app` directory in the container directory and modify `config.json`.

## Return code description
## 📖Return code description

The code meaning in the `body.code` field value in the interface return value.

Expand All @@ -141,7 +158,7 @@ The code meaning of `statuscode` returned by the interface.
| 429 | Too frequent requests |
| 500 | Server internal error (corresponding to body.code 4) |

## Remarks
## 🔖Remarks

### The following excellent codes may appear in this project.

Expand Down Expand Up @@ -237,7 +254,7 @@ The code meaning of `statuscode` returned by the interface.
f = e(c, b, a)
```

## Project agreement
## 📄Project agreement

This project is issued under [MIT](https://github.com/lxmusics/lx-music-api-server/blob/main/LICENSE) license. The following agreement is a supplement to the original MIT agreement. In case of conflict, the following agreement shall prevail.

Expand All @@ -248,9 +265,9 @@ Word agreement: "this project" in this agreement refers to this audio source pro
3. Any direct, indirect, special, accidental or consequential damages of any nature arising from the use of this project (including but not limited to damages caused by loss of goodwill, shutdown, computer failure or malfunction, or any and all other commercial damages or losses) shall be borne by the user.
4. This project is completely free of charge, and the open source is published on GitHub for people all over the world to learn and exchange technology. This project does not guarantee that the technology in the project may violate local laws and regulations. **It is forbidden to use this project in violation of local laws and regulations.** The user shall bear any illegal acts caused by the user knowing or not knowing that the local laws and regulations do not allow it, and this project will not bear any direct, indirect, special, accidental or consequential responsibilities.

If you use this project, you will accept the above agreement on your behalf.
Music platform is not easy, please respect copyright and support genuine.
If you use this project, you will accept the above agreement on your behalf.

Music platform is not easy, please respect copyright and support genuine.
This project is only used for the exploration and research of technical feasibility, and does not accept any commercial (including but not limited to advertising) cooperation and donation.
If you have any questions about this, please mail to:
helloplhm-qwq+outlook.com
Expand Down

0 comments on commit 0997464

Please sign in to comment.