Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 20 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,10 @@
This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
## Installation
```bash
pnpm install
```

## Getting Started

First, run the development server:

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

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`.

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.
# Purpose Mode

For further guidance, [visit our Documentation](https://docs.plasmo.com/)
Purpose Mode is an extension for Chromium-based browsers
that allows you to browse the Web with purpose,
free from distractions.

## Making production build
## Installation

Run the following:

Expand All @@ -30,8 +14,20 @@ pnpm build
npm run build
```

This should create a production bundle for your extension, ready to be zipped and published to the stores.
This should create the directory ./build/chrome-mv3-prod.
Next, go to your browser's extension page
(open [brave://extensions](brave://extensions)),
activate "Developer mode" in the top right corner,
and click on "Load unpacked" in the top left corner.
Select the directory "chrome-mv3-prod" that you just built.
That's it!

## Development

## Submit to the webstores
Start a development server like this:

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!
```bash
pnpm dev
# or
npm run dev
```
Binary file removed assets/Facebook.png
Binary file not shown.
Binary file removed assets/LinkedIn.png
Binary file not shown.
Binary file removed assets/Twitter.png
Binary file not shown.
Binary file removed assets/YouTube.png
Binary file not shown.
Binary file removed assets/survey.png
Binary file not shown.
Loading