Skip to content

Commit

Permalink
docs: add install link
Browse files Browse the repository at this point in the history
  • Loading branch information
monkeyWie committed Feb 24, 2024
1 parent 69aed56 commit c1d9bf6
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 26 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,32 @@
This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
[![Release](https://img.shields.io/github/release/GopeedLab/browser-extension.svg)](https://github.com/GopeedLab/browser-extension/releases)
[![Donate](https://img.shields.io/badge/%24-donate-ff69b4.svg)](https://docs.gopeed.com/donate.html)
[![Discord](https://img.shields.io/discord/1037992631881449472?label=Discord&logo=discord&style=social)](https://discord.gg/ZUJqJrwCGB)

## Getting Started
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R6IJGN6)

First, run the development server:
[English](/README.md) | [中文](/README_zh-CN.md)

```bash
pnpm dev
# or
npm run dev
```
## Install

[![Chrome](/_docs/img/store/chrome-web-store.png)](https://chromewebstore.google.com/detail/gopeed/mijpgljlfcapndmchhjffkpckknofcnd)

Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
## Features

You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
- 🔽 Instead of browser download manager
- 🔍 Sniff web resources
- ⚙️ Support multiple downloader configurations
- 📦 More..

For further guidance, [visit our Documentation](https://docs.plasmo.com/)
## Usage

## Making production build
1. First, you need to enable the downloader interface according to the [document](https://docs.gopeed.com/dev-api.html).
2. Add server configuration in the extension, as shown in the figure:
![](/_docs/img/guide/server-config.jpg)
3. When the configured server is displayed in green, the configuration is successful, and the browser download can be taken over.

Run the following:
## Build

```bash
pnpm build
# or
npm run build
pnpm install
pnpm run build
```

This should create a production bundle for your extension, ready to be zipped and published to the stores.

## Submit to the webstores

The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!
32 changes: 32 additions & 0 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[![Release](https://img.shields.io/github/release/GopeedLab/browser-extension.svg)](https://github.com/GopeedLab/browser-extension/releases)
[![Donate](https://img.shields.io/badge/%24-donate-ff69b4.svg)](https://docs.gopeed.com/donate.html)
[![Discord](https://img.shields.io/discord/1037992631881449472?label=Discord&logo=discord&style=social)](https://discord.gg/ZUJqJrwCGB)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R6IJGN6)

[English](/README.md) | [中文](/README_zh-CN.md)

## 安装

[![Chrome](/_docs/img/store/chrome-web-store.png)](https://chromewebstore.google.com/detail/gopeed/mijpgljlfcapndmchhjffkpckknofcnd)

## 功能

- 🔽 接管浏览器下载
- 🔍 嗅探网页资源
- ⚙️ 支持多个下载器配置
- 📦 More..

## 使用说明

1. 首先需要根据[文档](https://docs.gopeed.com/zh/dev-api.html)指引启用下载器接口。
2. 在扩展中添加服务器配置,如图所示:
![](/_docs/img/guide/server-config.jpg)
3. 当配置好的服务器显示绿色时,表示配置成功,即可接管浏览器下载。

## 构建

```bash
pnpm install
pnpm run build
```
Binary file added _docs/img/guide/server-config-step-1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/guide/server-config-step-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/guide/server-config-step-3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/guide/server-config.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/store/chrome-web-store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/store/firefox-add-ons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _docs/img/store/microsoft-store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 1 addition & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,7 @@
"manifest": {
"permissions": [
"system.display",
"downloads",
"contextMenus",
"activeTab",
"scripting"
"downloads"
]
}
}

0 comments on commit c1d9bf6

Please sign in to comment.