Skip to content

Commit

Permalink
docs(README): a brand new readme (Anankke#754)
Browse files Browse the repository at this point in the history
* docs(README): a brand new readme
* docs(README): update some typo
  • Loading branch information
SukkaW authored Aug 11, 2019
1 parent 600efed commit ae99bee
Showing 1 changed file with 87 additions and 38 deletions.
125 changes: 87 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,97 @@
# 欢迎使用 SSPanel V3 魔改再次修改版
<img src="https://cdn.jsdelivr.net/npm/skx@0.1.3/img/uim-logo-round.png" alt="logo" width="130" height="130" align="left" />

**ss-panel-v3-mod**是一款专为 Shadowsocks/ShadowsocksR 设计的管理面板,再次感谢 ss-panel-v3-mod 的制作者,修改后的功能简介:
<h1>SSPanel UIM</h1>

- **支付系统集成**:集成 支付宝当面付 易付通 码支付 TrimePay 等多种支付系统,使用方法见项目[wiki](https://github.com/Anankke/SSPanel-Uim/wiki/)
- **UI** :修改为 ~~援交~~ 圆角、并自定义了几个图标的显示,节点列表等級 0 可见等級 1 节点但无法看见节点详情,增加了国家图标显示
- **商店**:商品增加同时连接设备数,用户限速属性
- 从肥羊那里****来的:新用户注册现金奖励|高等级节点体验|设备数量限制
- **优化**:css 和 js 等置入本地提升加载速度
- 增加 **v2Ray** 功能,详情请看 wiki: [Indexyz 版](https://github.com/Anankke/SSPanel-Uim/wiki/v2ray---indexyz-%E7%89%88%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B) | [Rico 版](https://github.com/Anankke/SSPanel-Uim/wiki/v2ray---Rico-%E7%89%88%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B)
> Across the Great Wall we can reach every corner in the world
<br/>

[![License](https://img.shields.io/github/license/Anankke/SSPanel-Uim?style=flat-square)](https://github.com/Anankke/SSPanel-Uim/blob/dev/LICENSE)
[![Travis Build Status](https://img.shields.io/travis/Anankke/SSPanel-UIM/master.svg?style=flat-square)](https://travis-ci.org/Anankke/SSPanel-Uim)
![GitHub repo size](https://img.shields.io/github/repo-size/anankke/sspanel-uim?style=flat-square&color=328657)
[![Telegram Channel](https://img.shields.io/badge/news-t.me%2Fsspanel_uim-0d86d7?style=flat-square)](https://t.me/sspanel_uim)
[![Telegram Chat](https://img.shields.io/badge/chat-t.me%2Fssunion-0d86d7?style=flat-square)](https://t.me/ssunion)

[演示站点](https://sspanel.host) | [使用文档](https://wiki.sspanel.host) | [更新日志](https://github.com/Anankke/SSPanel-Uim/releases) | [Telegram 频道](https://t.me/sspanel_uim) | [Telegram 水群](https://t.me/ssunion)

## 简介

SSPanel UIM 是一款专为 Shadowsocks / ShadowsocksR / V2Ray 设计的多用户管理面板,基于 ss-panel-v3-mod 开发。

## 特性

- 集成超过 8 种支付系统
- 重构面板首页、节点列表、商品列表;新增 SPA(Single Page Apps)版 UI
- 商品增加同时连接设备数,用户限速属性
- 新用户注册现金奖励、用户常规端口切换与指定
- 公共库文件加载使用 jsDelivr
- 支持 V2Ray
- 巨量性能优化
- 更多新功能写不下了。(确信)
- 更多新功能写不下了

Telegram 频道 :https://t.me/sspanel_Uim
## 安装

Telegram ~~可能是个官方~~水群 :https://t.me/SSUnion
SSPanel UIM 的需要以下程序才能正常的安装和运行:

记得点小星星!
- Git
- MySQL
- PHP 7.2+
- Composer

演示站: [sspanel.host](https://sspanel.host) 账号和密码都是 `admin` 对接节点的 `mukey=NimaQu`
SSPanel UIM 支持安装在 LNMP、宝塔面板、Plesk 面板、oneinstack 等集成环境中。安装教程请参阅 [文档](https://wiki.sspanel.host)

**原作者** [galaxychuck](https://github.com/galaxychuck)
## 演示

[支持开发者请点我](https://github.com/Anankke/SSPanel-Uim#%E5%85%B3%E4%BA%8E%E6%8D%90%E8%B5%A0)
[演示站](https://sspanel.host) 每天更新 `dev` 分支最新源码。

## Wiki
```
账号:admin
密码:admin
mukey=NimaQu
```

https://wiki.sspanel.host
## 文档

#### 鸣谢
> 我们安装,我们更新,我们开发
##### [Anankke](https://github.com/galaxychuck)
[SSPanel UIM 的文档](https://wiki.sspanel.host),在这里你可以找到大部分问题的解答。

- 面板现 **维护者**
## 贡献

##### [galaxychuck](https://github.com/galaxychuck)
[提出新想法 & 提交 Bug](https://github.com/Anankke/SSPanel-Uim/issues/new) | [改善文档 & 投稿](https://github.com/sspanel-uim/Wiki) | [Fork & Pull Request](https://github.com/Anankke/SSPanel-Uim/fork)

SSPanel UIM 欢迎各种贡献,包括但不限于改进,新功能,文档和代码改进,问题和错误报告。

## 协议

SSPanel UIM 使用 MIT License 开源、不提供任何担保。使用 SSPanel UIM 即表明,您知情并同意:

- 您在使用 SSPanel UIM 时,必须保留 Staff 页面(该页面包含了 MIT License)和页脚的 Staff 入口
- SSPanel UIM 不会对您的任何损失负责,包括但不限于服务中断、Kernel Panic、机器无法开机或正常使用、数据丢失或硬件损坏、原子弹爆炸、第三次世界大战、SCP 基金会无法阻止 SCP-3125 引发的全球 MK 级现实重构等

- 面板 **原作者**

##### [hkserversolution](https://www.hkserversolution.com/cart.php)
## 鸣谢

- Demo 演示站服务器赞助
### [HKServerSolution](https://www.hkserversolution.com/cart.php)

##### [dumplin](https://github.com/dumplin233)
Demo 演示站服务器赞助。

### [贡献者](https://github.com/Anankke/SSPanel-Uim/graphs/contributors)

SSPanel UIM 离不开所有 [贡献代码](https://github.com/Anankke/SSPanel-Uim/graphs/contributors) 和提交 Issue 的人。

<details>
<summary>查看贡献者</summary>

#### [Anankke](https://github.com/Anankke)

- 面板现 **维护者**

#### [galaxychuck](https://github.com/galaxychuck)

- 面板 **原作者**

##### [dumplin](https://github.com/dumplin233)

- 码支付对接 + 码支付当面付二合一
- 为面板加入 AFF 链接功能
Expand Down Expand Up @@ -75,8 +125,8 @@ https://wiki.sspanel.host

[**CGDF**](https://github.com/CGDF-GitHub)

- xcat一键update
- 适配SSD
- xcat 一键 update
- 适配 SSD
- 用户列表分页加载

[**CHEN**](https://github.com/ChenSee)
Expand All @@ -89,35 +139,34 @@ https://wiki.sspanel.host
- 新版 Vue(SPA) 版界面
- 重写节点列表,支持分级显示所有级别节点

[**sukka**](https://skk.moe)
[**Sukka**](https://github.com/SukkaW)

- Travis CI 持续集成
- 单元测试
- 全站 JavaScript 的重写
- 全站 JavaScript 重写
- 新版 Wiki 的搭建和维护

#### 还有所有被引用过代码的同学,以及所有提交过 pr/issue 的同学。
</details>

#### 关于捐赠
## 捐赠

您对我们的帮助将是支持我们做下去的动力,只需您在购买部分产品或向他人推荐产品时从我们的返利链接购买,这就是对我们很大的支持了。~~没有钱了,肯定要做啊,不做没有钱用啊,打工是不可能打工的,这辈子不可能打工的~~
您对我们的帮助将是支持我们做下去的动力。您可以直接进行捐赠,也可以在购买部分产品或向他人推荐产品时从我们的返利链接购买。

##### Anankke
#### Anankke

- [Anankke 很可爱请给 Anankke 钱](https://t.me/anankke/5)

##### dumplin
#### dumplin

- [码支付-微信收款功能开通](https://codepay.fateqq.com/i/39756)

##### galaxychuck
#### galaxychuck

- [黛米付-支付接入](https://www.daimiyun.cn/register.php?aff=624)
- [冲上云霄云主机](http://console.soar-clouds.com/aff.php?aff=94)
- [Vultr](https://www.vultr.com/?ref=7205737)

[laurieryayoi 的前端课程报名](https://t.me/kinokonominoco)
#### laurieryayoi

## 免责声明
[laurieryayoi 的前端课程报名](https://t.me/kinokonominoco)

本程序由 MIT License 授权。**不提供任何担保**。使用本程序即表明,您知情并同意:程序开发者不对此程序导致的任何服务中断、数据损失或任何少见未列出的事故负责。

0 comments on commit ae99bee

Please sign in to comment.