From e393d0721eca3db2459a917b00d4baebebeeda58 Mon Sep 17 00:00:00 2001
From: HanYaodong
Date: Fri, 2 Feb 2024 20:45:02 +0800
Subject: [PATCH] Update README
---
LICENSE-HISTORY.txt | 171 --------------------------------------------
README.md | 71 +++++++-----------
2 files changed, 24 insertions(+), 218 deletions(-)
delete mode 100644 LICENSE-HISTORY.txt
diff --git a/LICENSE-HISTORY.txt b/LICENSE-HISTORY.txt
deleted file mode 100644
index 25bdd313..00000000
--- a/LICENSE-HISTORY.txt
+++ /dev/null
@@ -1,171 +0,0 @@
-Prior to commit 7338af3b384e2297eaf710443121ac840099a9f1, this project was licensed under LGPL 3.0.
-
-You must follow LICENSE instead if you want to use any newer version.
-
-----
-
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
- This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
- 0. Additional Definitions.
-
- As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
- "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
- An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
- A "Combined Work" is a work produced by combining or linking an
-Application with the Library. The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
- The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
- The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
- 1. Exception to Section 3 of the GNU GPL.
-
- You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
- 2. Conveying Modified Versions.
-
- If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
- a) under this License, provided that you make a good faith effort to
- ensure that, in the event an Application does not supply the
- function or data, the facility still operates, and performs
- whatever part of its purpose remains meaningful, or
-
- b) under the GNU GPL, with none of the additional permissions of
- this License applicable to that copy.
-
- 3. Object Code Incorporating Material from Library Header Files.
-
- The object code form of an Application may incorporate material from
-a header file that is part of the Library. You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
- a) Give prominent notice with each copy of the object code that the
- Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the object code with a copy of the GNU GPL and this license
- document.
-
- 4. Combined Works.
-
- You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
- a) Give prominent notice with each copy of the Combined Work that
- the Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the Combined Work with a copy of the GNU GPL and this license
- document.
-
- c) For a Combined Work that displays copyright notices during
- execution, include the copyright notice for the Library among
- these notices, as well as a reference directing the user to the
- copies of the GNU GPL and this license document.
-
- d) Do one of the following:
-
- 0) Convey the Minimal Corresponding Source under the terms of this
- License, and the Corresponding Application Code in a form
- suitable for, and under terms that permit, the user to
- recombine or relink the Application with a modified version of
- the Linked Version to produce a modified Combined Work, in the
- manner specified by section 6 of the GNU GPL for conveying
- Corresponding Source.
-
- 1) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (a) uses at run time
- a copy of the Library already present on the user's computer
- system, and (b) will operate properly with a modified version
- of the Library that is interface-compatible with the Linked
- Version.
-
- e) Provide Installation Information, but only if you would otherwise
- be required to provide such information under section 6 of the
- GNU GPL, and only to the extent that such information is
- necessary to install and execute a modified version of the
- Combined Work produced by recombining or relinking the
- Application with a modified version of the Linked Version. (If
- you use option 4d0, the Installation Information must accompany
- the Minimal Corresponding Source and Corresponding Application
- Code. If you use option 4d1, you must provide the Installation
- Information in the manner specified by section 6 of the GNU GPL
- for conveying Corresponding Source.)
-
- 5. Combined Libraries.
-
- You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
- a) Accompany the combined library with a copy of the same work based
- on the Library, uncombined with any other library facilities,
- conveyed under the terms of this License.
-
- b) Give prominent notice with the combined library that part of it
- is a work based on the Library, and explaining where to find the
- accompanying uncombined form of the same work.
-
- 6. Revised Versions of the GNU Lesser General Public License.
-
- The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
- If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
diff --git a/README.md b/README.md
index d4589bdd..d5817d4e 100644
--- a/README.md
+++ b/README.md
@@ -5,74 +5,51 @@
Logo by @munadikieh
-SponsorBlock
+BilibiliSponsorBlock(文档施工中)
-
- Download:
- Chrome/Chromium |
- Firefox |
- Android |
- Edge |
- Safari for MacOS and iOS |
- Website |
- Stats
-
+BilibiliSponsorBlock是一款帮你跳过B站视频中广告片段的浏览器插件,插件自动获取并跳过广告片段,让你的刷视频体验毫无中断!插件中所有的标注片段都来自热心网友,您也可以提交自己的标注来帮助他人。除了广告之外,插件还支持其他类别,例如开场结尾的动画,一键三连提示等等。
-
- 3rd-Party Ports:
- MPV |
- Kodi |
- Chromecast |
- iOS
-
-
-
-
-
-
-
-
-
+目前本项目还处于开发中(包括本文档)。
+本插件移植自油管插件[SponsorBlock](https://github.com/ajayyy/SponsorBlock),保留了大部分的UI和使用方法,加入一些了B站特色的功能。
+# 相比[原插件](https://github.com/ajayyy/SponsorBlock)变化
-SponsorBlock is an open-source crowdsourced browser extension to skip sponsor segments in YouTube videos. Users submit when a sponsor happens from the extension, and the extension automatically skips sponsors it knows about. It also supports skipping other categories, such as intros, outros and reminders to subscribe.
+- 放弃了多语言支持。不会真的有人看不懂中文还在刷B站吧?
-It also supports Invidious.
+- 放弃了移动端网页支持。日后计划做一个ReVanced插件,移动端网页真的有人用吗?
-**Translate:** [![Crowdin](https://badges.crowdin.net/sponsorblock/localized.svg)](https://crowdin.com/project/sponsorblock)
+- 放弃了第三方镜像站支持。我不清楚B站有没有镜像站,如果大家知道有使用人数多的欢迎提Issue。
-# Important Links
+- 加入动态标记功能(制作中)。恰饭动态真的好多,甚至比视频更得还快。
-See the [Wiki](https://github.com/ajayyy/SponsorBlock/wiki) for important links.
+- 加入评论标记功能(制作中)。不用多说了,百亿红包,点击就领!评论区置顶链接yyds!
-# Server
+# 功能更新计划
-The backend server code is available here: https://github.com/ajayyy/SponsorBlockServer
+- 评论和动态标记
-To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database ([License](https://github.com/ajayyy/SponsorBlock/wiki/Database-and-API-License)). If you are planning on using the database in another project, please read the [API Docs](https://wiki.sponsor.ajay.app/index.php/API_Docs) page for more information.
+- 搬运视频自动获取油管标注
-The dataset and API are now being used in some [ports](https://github.com/ajayyy/SponsorBlock/wiki/3rd-Party-Ports) as well as a [neural network](https://github.com/andrewzlee/NeuralBlock).
+- 完善文档
-# API
+- 欢迎大家提出意见和建议!
-You can read the API docs [here](https://wiki.sponsor.ajay.app/w/API_Docs).
+# 服务端
-# Building
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+服务端代码(同样也在开发中):https://github.com/HanYaodong/SponsorBlockServer
-# Credit
+# API
-The awesome [Invidious API](https://docs.invidious.io/) was previously used, and the server is now using [NewLeaf](https://git.sr.ht/~cadence/NewLeaf) as a to get video info from YouTube.
+油管原项目的[API](https://wiki.sponsor.ajay.app/w/API_Docs),本项目对API改动很小,可以先参考原项目文档。
-Originally forked from [YTSponsorSkip](https://github.com/NDevTK/YTSponsorSkip), but very little code remains.
+# 搭建项目
+详见 [CONTRIBUTING.md](CONTRIBUTING.md)
-Icons made by:
-* Gregor Cresnar from www.flaticon.com and are licensed by CC 3.0 BY
-* Freepik from www.flaticon.com and are licensed by CC 3.0 BY
-* Alexander Kahlkopf from iconmonstr.com and are licensed by iconmonstr License
+# 致谢
+感谢[ajayyy](https://github.com/ajayyy)创建的[SponsorBlock](https://github.com/ajayyy/SponsorBlock)给我的启发!
### License
-This project is licensed under GNU LGPL v3 or any later version
+This project is licensed under GNU GPL v3 or any later version