mirror of
https://github.com/BewlyBewly/BewlyBewly.git
synced 2025-04-14 13:15:29 +00:00
107 lines
5.4 KiB
Markdown
107 lines
5.4 KiB
Markdown
# BewlyBewly
|
||
|
||
English | [简体中文](README-cmn_CN.md) | [正體中文](README-cmn_TW.md) | [廣東話](README-jyut.md)
|
||
|
||
<p align="center" style="margin-bottom: 0px !important;">
|
||
<img width="150" src="https://user-images.githubusercontent.com/33394391/160250512-410b71fc-7f25-4caf-b850-429227ff082a.png"><br/>
|
||
</p>
|
||
|
||
<h1 align="center" style="margin-top: 0px;">BewlyBewly</h1>
|
||
|
||
<p align="center">Just make a few small changes to your Bilibili homepage.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## ⬇️ Installation
|
||
|
||
### Online Installation
|
||
|
||
Even in the Edge browser, we strongly recommend you install it in the Chrome web store. In terms of review speed, the Chrome web store is slightly faster than Edge Add-ons.
|
||
|
||
- Chrome: <https://chrome.google.com/webstore/detail/bewlybewly/bbbiejemhfihiooipfcjmjmbfdmobobp/related?hl=en>
|
||
- Edge: <https://microsoftedge.microsoft.com/addons/detail/bewlybewly/kceadhehfjdiakpiphpjgolbgehjdmja>
|
||
- Firefox: **I NEED SOME HELP!!!!!!!!!!!!!!!!!! ( ；∀；)**
|
||
|
||
### Local Installation
|
||
|
||
[CI](https://github.com/hakadao/BewlyBewly/actions)：Automatically build with the latest code
|
||
|
||
[Releases](https://github.com/hakadao/BewlyBewly/releases)：Stable version
|
||
|
||
#### Edge & Chrome (RECOMMENDED)
|
||
|
||
> Ensure you installed [extension.zip](https://github.com/hakadao/BewlyBewly/releases) .
|
||
|
||
Opening the `edge://extensions` page in the Edge or `chrome://extensions` page in the Chrome, simply drag and drop the downloaded `extension.zip` file into the browser to complete the installation.
|
||
|
||
<details>
|
||
<summary> Another installation method for Edge & Chrome </summary>
|
||
|
||
#### Edge
|
||
|
||
> Ensure you installed [extension.zip](https://github.com/hakadao/BewlyBewly/releases) and decompress this file.
|
||
|
||
1. Type in `edge://extensions/` in the address bar and press Enter
|
||
2. Turn on `Developer mode` then press `Load unpacked` <br/> <img width="655" alt="image" src="https://user-images.githubusercontent.com/33394391/232246901-e3544c16-bde2-480d-b770-ca5242793963.png">
|
||
3. Load the decompressed extension folder in your browser
|
||
|
||
#### Chrome
|
||
>
|
||
> Ensure you installed [extension.zip](https://github.com/hakadao/BewlyBewly/releases) and decompress this file.
|
||
|
||
1. Type in `chrome://extensions/` in the address bar and press Enter
|
||
2. Turn on `Developer mode` then press `Load unpacked` <br/> <img width="655" alt="Snipaste_2022-03-27_18-17-04" src="https://user-images.githubusercontent.com/33394391/160276882-13da0484-92c1-47dd-add8-7655c5c2bf1c.png">
|
||
3. Load decompressed exetension folder in your browser
|
||
|
||
</details>
|
||
|
||
## 🔧 Development & build
|
||
|
||
### Development
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
Then **load extension in browser with the `extension/` folder**.
|
||
After each modification, you need to click the [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) button and refresh the page to ensure the changes would be applied.
|
||
|
||
### Build
|
||
|
||
To build the extension, run
|
||
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
And then pack files under `extension`
|
||
|
||
### 🤝 Contribution
|
||
|
||
#### About branches
|
||
|
||
- **Main**: This branch is designed for changes that are restricted to documentation files like READMEs, without altering the code or its functionality.
|
||
- **Dev**: Use this brach for new features, performance improvements or modifications to i18n files.
|
||
- **Bugfixes**: This branch should be used exclusively for fixing bugs that appear in the main branch.
|
||
|
||
#### I18n
|
||
|
||
- When doing translations, if you have a language you are not familiar with, you can use another language that you have translated and point out what language you cannot translate in the pull request.
|
||
|
||
- **Please MANUALLY MAINTAIN the i18n files!!!** Do not use `i18n Ally` or other extensions to maintain them. I know you might be confused or might not like this, but using `i18n Ally` for the maintenance will be uncertain where to place the translations afterward or delete the code comments.
|
||
|
||
## ❤️ Credits
|
||
|
||
- [vitesse-webext](https://github.com/antfu/vitesse-webext) - The template used for this project
|
||
- [UserScripts/bilibiliHome](https://github.com/indefined/UserScripts/tree/master/bilibiliHome), [bilibili-app-recommend](https://github.com/magicdawn/bilibili-app-recommend) - Reference source for obtaining the access key
|
||
- [Bilibili-Evolved](https://github.com/the1812/Bilibili-Evolved) - Partial implementation of functionalities
|
||
- [bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect)
|