Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mokeyjay committed Nov 18, 2023
1 parent 2f7b614 commit 4f7e13e
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 25 deletions.
18 changes: 8 additions & 10 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,26 +44,24 @@ Both APIs automatically return the respective cross-domain header according to `
> The `image` and `url` keys are for compatibility purposes for users of 4.x or earlier versions, they can be ignored
## 🆙 Upgrading Guide
### Upgrading From 5.1 to 5.2
### Upgrading From 5.2 to 5.3
1. [Download the Source Code](https://github.com/mokeyjay/pixiv-daily-ranking-widget/releases/latest)
2. Unzip and overwrite the `app` and `index.php` to on your server
3This version adds a new config item `header_script`, so you can customize statistics code or js script
2. Unzip and overwrite the `app` and `index.php` to your server

### Upgrading From 4.x to 5.x
1. Check the code comment of `image_hosting` item in [config.php](https://github.com/mokeyjay/Pixiv-daily-ranking-widget/blob/master/config.php#L88), select the most suitable image hosting option and fill it in your `config.php`
2. Delete all files in `storage/app` to enable the application refreshing the ranking data

## 🌟 Changelog
### New Features
- Support Docker (thanks to @hujingnb)
- `header_script` configuration item, so you can customize statistics code or js script
- Added `ranking_type` configuration option, which now allows you to select whether to fetch the overall or illustration/manga daily rankings.
- Added image preloading to improve the experience in poor network environments.
### Optimizations
- Used the proxy service provided by pixiv.cat as a final guarantee plan
- Riyugo image hosting changed to vip version, you need to buy a vip account before use it (free version is no longer available)
- Improve image download integrity check mechanism
- Removed built-in statistics code
- Completely rewritten the frontend with more elegant animation effects.
- Removed the dependency on Bootstrap for faster loading.
- Switched to using the official PHP and Nginx packages.
### Other
- Removed invalid JD, imgurl, imgtg and saoren image hosting
- Removed the `static_cdn` configuration option due to the removal of the dependency on Bootstrap.

[History](https://github.com/mokeyjay/Pixiv-daily-ranking-widget/blob/master/doc/log.en.md)

Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,24 @@
> `image``url` 两个键是为了兼容 4.x 及之前版本的用户,无需理会
## 🆙 升级指南
### 从 5.1 升级到 5.2
### 从 5.2 升级到 5.3
1. [下载源代码](https://github.com/mokeyjay/Pixiv-daily-ranking-widget/releases/latest)
2. 解压缩,将其中的 `app``index.php` 覆盖到线上环境
3. 此版本添加了新的配置项 `header_script`,以便你自定义访问统计或者 js 代码

### 从 4.x 升级到 5.x
1. 查看 [config.php](https://github.com/mokeyjay/Pixiv-daily-ranking-widget/blob/master/config.php#L88)`image_hosting` 配置项的注释说明,选择适合你的图床配置,填写到你线上环境的 `config.php`
2. 删除 `storage/app` 下的所有文件,让程序重新获取排行榜数据

## 🌟 更新日志
### 新增
- 支持 Docker 部署(感谢 @hujingnb
- `header_script` 配置项,以便自行部署的用户自定义访问统计或其他 js 代码
- `ranking_type` 配置项,现在可以选择拉取综合还是插画、漫画日榜啦~
- 图片预加载,优化网络环境较差时的体验
### 优化
- 使用了 pixiv.cat 提供的代理服务作为最后的保底方案
- 薄荷图床改为会员版本,需要购买会员后才能使用(免费版已失效)
- 完善图片下载完整度检查机制
- 去掉了内置的访问统计代码
- 完全重写了前端,更优雅的缓动效果
- 不再依赖 bootstrap,加载更快啦
- 改为使用官方 php、nginx 包
### 其他
- 去掉失效的京东、imgurl、imgtg、saoren 图床
- 由于不再依赖 bs,去除 `static_cdn` 配置项

[历史更新日志](https://github.com/mokeyjay/Pixiv-daily-ranking-widget/blob/master/doc/log.md)

Expand Down
10 changes: 5 additions & 5 deletions config.php
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* P.S. If you want to trigger the refresh job via cli, and you are using a local image-hosting, this field is required
* Otherwise, the generated image full URL may have problems
*/
'url' => '',
'url' => 'http://pixiv.test/',

/**
* 背景颜色。默认值为 transparent (透明)。你也可以通过 url 参数 color 来设置
Expand All @@ -33,7 +33,7 @@
* It also prevents some low-performance hosts from using too many resources when caching images, which can lead to jamming or alarms
* Usually the default 50 is fine
*/
'limit' => 50,
'limit' => 10,

/**
* 是否对外提供服务
Expand All @@ -48,7 +48,7 @@
* 日志级别。可多选:DEBUG、ERROR 或留空不记录任何日志
* Logging level. Multiple options: DEBUG, ERROR or leave blank to not record any logs
*/
'log_level' => [],
'log_level' => ['DEBUG', 'ERROR'],

/**
* 代理服务器配置。例如 127.0.0.1:1080
Expand Down Expand Up @@ -85,7 +85,7 @@
*
* It is recommended to fill in more than one image-hosting, if one of them fails to upload, it will continue to try other image-hosting in order
*/
'image_hosting' => ['tsesze', 'fifty-eight', 'chkaja', 'pngcm', 'catbox', 'local'],
'image_hosting' => ['local'],

/**
* 图床扩展配置信息
Expand Down Expand Up @@ -120,7 +120,7 @@
* Disable web-trigger update job, cli-trigger only
* See doc/deploy.en.md
*/
'disable_web_job' => false,
'disable_web_job' => true,

/**
* 放置在页面 <header> 标签下的 js 脚本内容,通常用来放置统计代码
Expand Down
2 changes: 1 addition & 1 deletion doc/docker.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Docker
> If you need to enable multiple containers, share the /var/www/html/storage directory between them by mounting it to avoid each container updating the ranking data separately and causing performance waste
> If you need to enable multiple containers, share the `/var/www/html/storage` directory between them by mounting it to avoid each container updating the ranking data separately and causing performance waste
## Deployment
### Command
Expand Down
12 changes: 12 additions & 0 deletions doc/log.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# History Update Log
## 5.2
### New Features
- Support Docker (thanks to @hujingnb)
- `header_script` configuration item, so you can customize statistics code or js script
### Optimizations
- Used the proxy service provided by pixiv.cat as a final guarantee plan
- Riyugo image hosting changed to vip version, you need to buy a vip account before use it (free version is no longer available)
- Improve image download integrity check mechanism
- Removed built-in statistics code
### Other
- Removed invalid JD, imgurl, imgtg and saoren image hosting

## 5.1
### New Features
- JD, Riyugo, FiftyEight image hosting
Expand Down
12 changes: 12 additions & 0 deletions doc/log.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# 历史更新日志
## 5.2
### 新增
- 支持 Docker 部署(感谢 @hujingnb
- `header_script` 配置项,以便自行部署的用户自定义访问统计或其他 js 代码
### 优化
- 使用了 pixiv.cat 提供的代理服务作为最后的保底方案
- 薄荷图床改为会员版本,需要购买会员后才能使用(免费版已失效)
- 完善图片下载完整度检查机制
- 去掉了内置的访问统计代码
### 其他
- 去掉失效的京东、imgurl、imgtg、saoren 图床

## 5.1
### 新增
- 京东、薄荷、58图床
Expand Down

0 comments on commit 4f7e13e

Please sign in to comment.