From 0876d414217dc90d46d1cbbaacd862c188b691f6 Mon Sep 17 00:00:00 2001 From: Pig Fang Date: Tue, 26 Mar 2019 15:55:59 +0800 Subject: [PATCH] Update readme --- README.md | 43 ++++++++++++++++++++++++++----------------- README_EN.md | 51 ++++++++++++++++++++++++++++++--------------------- 2 files changed, 56 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index e79191e8..44827931 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Blessing Skin 是一款能让您上传、管理和分享您的 Minecraft 皮肤 Blessing Skin 是一个开源的 PHP 项目，这意味着您可以自由地在您的服务器上部署它。 -特性 ------------ +## 特性 + - 完整实现了一个皮肤站该有的功能 - 支持单用户多个角色 - 通过皮肤库来分享您的皮肤和披风！ @@ -37,8 +37,8 @@ Blessing Skin 是一个开源的 PHP 项目，这意味着您可以自由地在 - 支持与 Authme/Discuz 等程序的用户数据对接（插件） - 支持自定义 Yggdrasil API 外置登录系统（插件） -环境要求 ------------ +## 环境要求 + Blessing Skin 对您的服务器有一定的要求。_在大多数情况下，下列所需的 PHP 扩展已经开启。_ - 一台支持 URL 重写的主机，Nginx、Apache 或 IIS @@ -54,21 +54,30 @@ Blessing Skin 对您的服务器有一定的要求。_在大多数情况下， - JSON - fileinfo -快速使用 ------------ +## 快速使用 + 请参阅 [Wiki - 快速安装向导](https://github.com/bs-community/blessing-skin-server/wiki/%E5%BF%AB%E9%80%9F%E5%AE%89%E8%A3%85%E5%90%91%E5%AF%BC)。 ![screenshot](https://img.blessing.studio/images/2017/07/29/2017-06-16_15.54.16.png) -插件系统 ------------- +## 插件系统 Blessing Skin 提供了强大的插件系统，您可以通过添加多种多样的插件来为您的皮肤站添加功能。 详情请参阅 [Wiki - 插件系统介绍](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8F%92%E4%BB%B6%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D)。 -自行构建 ------------- +## 支持并赞助 Blessing Skin + +如果您觉得这个软件对您很有帮助，欢迎通过赞助来支持开发！ + +目前可在 [爱发电](https://afdian.net/@blessing-skin) 上赞助。 + +### Sponsors + +### Backers + +## 自行构建 + 如果你想为此项目作贡献，或者抢先尝试未发布的新功能，你应该先用 GitHub 上的代码部署。 **不推荐不熟悉 shell 操作以及不想折腾的用户使用。** @@ -97,21 +106,21 @@ yarn build 接下来请参考「快速安装向导」进行后续安装。 -国际化（i18n） ------------- +## 国际化（i18n） + Blessing Skin 可支持多种语言，当前支持英语（`en`）和简体中文（`zh_CN`）。 当然，您也可以添加您自己的语言。请参阅 [Wiki - 添加其它语言 [i18n]](https://github.com/bs-community/blessing-skin-server/wiki/%E6%B7%BB%E5%8A%A0%E5%85%B6%E4%BB%96%E8%AF%AD%E8%A8%80-%5Bi18n%5D) 如果您愿意将您的翻译贡献出来，欢迎参与 [我们的 Crowdin 项目](https://crowdin.com/project/bs-i18n)。 -问题报告 ------------- +## 问题报告 + 请参阅 [Wiki - 报告问题的正确姿势](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E7%9A%84%E6%AD%A3%E7%A1%AE%E5%A7%BF%E5%8A%BF)。 -版权 ------------- -Copyright 2016-2019 printempw and contributors. +## 版权 + +Copyright 2016-2019 The Blessing Community Blessing Skin 是基于 GNU General Public License version 3 开放源代码的自由软件，你可以遵照 GPLv3 协议来修改或重新发布本程序。 diff --git a/README_EN.md b/README_EN.md index ba70df66..77f8ce75 100644 --- a/README_EN.md +++ b/README_EN.md @@ -19,8 +19,8 @@ Blessing Skin is a web application where you can upload, manage and share your c Blessing Skin is an open-source project written in PHP, which means you can deploy it freely on your own web server! -Features ------------ +## Features + - A fully functional skin hosting service - Multiple player names can be owned by one user on the website - Share your skins and capes online with skin library! @@ -37,8 +37,8 @@ Features - Integration with Authme/CrazyLogin/Discuz (available as plugin) - Support custom Yggdrasil API authentication (available as plugin) -Requirements ------------ +## Requirements + Blessing Skin has only a few system requirements. _In most cases, these PHP extensions are already enabled._ - Web server with URL rewriting enabled @@ -53,23 +53,32 @@ Blessing Skin has only a few system requirements. _In most cases, these PHP exte - JSON PHP Extension - fileinfo PHP Extension -Quick Install ------------ +## Quick Install + 1. Download our [latest release](https://github.com/bs-community/blessing-skin-server/releases), extract to where you like to installed on. 2. Rename `.env.example` to `.env` and configure your database information. (For windows users, just rename it to `.env.`, and the last dot will be removed automatically) 3. For Nginx users, add [rewrite rules](#configure-the-web-server) to your Nginx configuration 4. Navigate to `http://your-domain.com/setup` in your browser. If 404 is returned, please check whether the rewrite rules works correctly. 5. Follow the setup wizard and your website is ready-to-go. -Plugin System ------------- +## Plugin System Blessing Skin provides an elegant and powerful plugin system, and you can attach plenty of functions and customization to your site via installing plugins. For more information, please refer to [Wiki - Introducing plugin system](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8F%92%E4%BB%B6%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D). -Developer Install ------------- +## Supporting Blessing Skin + +Welcome to sponsoring Blessing Skin if this software is useful for you! + +Currently you can sponsor us via [爱发电](https://afdian.net/@blessing-skin). + +### Sponsors + +### Backers + +## Developer Install + If you'd like make some contribution on the project, please deploy it from GitHub first. **You'd better have some experience on shell operations to continue.** @@ -98,8 +107,8 @@ yarn build Congrats! You made it. Next, please refer to No.2 of **Quick Install** section. -Configure the Web Server ------------- +## Configure the Web Server + For Apache (most of the virtual hosts) and IIS users, there is already a pre-configured file for you. What you need is just to enjoy! For Nginx users, **please add the following rules** to your Nginx configuration file: @@ -114,29 +123,29 @@ location ~ /\.env { } ``` -Mod Configuration ------------- +## Mod Configuration + Please refer to [Wiki - Mod Configuration](https://github.com/bs-community/blessing-skin-server/wiki/%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E7%9A%AE%E8%82%A4-Mod). ![screenshot](https://img.blessing.studio/images/2017/07/29/2017-06-16_15.54.16.png) -Internationalization ------------- +## Internationalization + Blessing Skin supports multiple languages, while currently supporting English (`en`) and Simplified Chinese (`zh_CN`). Of course, you can add your own language. Please check [Wiki - Add other language [i18n]](https://github.com/bs-community/blessing-skin-server/wiki/%E6%B7%BB%E5%8A%A0%E5%85%B6%E4%BB%96%E8%AF%AD%E8%A8%80-%5Bi18n%5D) (Simplified Chinese only). If you are willing to contribute your translation, welcome to join [our Crowdin project](https://crowdin.com/project/bs-i18n). -Report Problems ------------- +## Report Bugs + Read [Wiki - FAQ](https://github.com/bs-community/blessing-skin-server/wiki/FAQ) and double check if your situation doesn't suit any case mentioned there before reporting. When reporting a problem, please attach your log file (located at `storage/logs/laravel.log`) and the information of your server where the error occured on. You should also read this [guide](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E7%9A%84%E6%AD%A3%E7%A1%AE%E5%A7%BF%E5%8A%BF) before reporting a problem. -Copyright & License ------------- -Copyright 2016-2019 [printempw](https://blessing.studio/) and contributors. +## Copyright & License + +Copyright 2016-2019 The Blessing Community Blessing Skin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3.