171 lines
5.7 KiB
Markdown
171 lines
5.7 KiB
Markdown
# ![img](/src/img/logo.png) Share Freedom - browser extension
|
|
|
|
Share the current tab on the [fediverse](https://fediverse.party/).
|
|
|
|
[![Firefox Add-on](/src/img/badge-amo.png)](https://addons.mozilla.org/en-US/firefox/addon/share-freedom/)
|
|
|
|
|
|
## Features
|
|
|
|
Simplest add-on for the fediverse. Share web pages right from the toolbar button.
|
|
|
|
Supported services/protocols:
|
|
- Gnusocial
|
|
- Mastodon / Misskey
|
|
- Hubzilla
|
|
- Diaspora
|
|
- Friendica
|
|
- Socialhome
|
|
- Lemmy
|
|
- Pleroma
|
|
- Osada / Zap / Zot6
|
|
- XMPP
|
|
|
|
## Contributing
|
|
|
|
You can contribute in the following ways:
|
|
|
|
- Finding and reporting bugs
|
|
- Contributing code to the project by fixing bugs or implementing features
|
|
|
|
|
|
### Bug reports
|
|
|
|
Bug reports and feature suggestions can be submitted to [Gitlab Issues](https://gitlab.com/mickie1/share-freedom-extension/issues). Please make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected in the past using the search function. Please also use descriptive, concise titles.
|
|
|
|
|
|
### Pull request
|
|
|
|
Please use clean, concise titles for your pull requests.
|
|
|
|
|
|
## Invite an ice cream
|
|
|
|
You can collaborate with __donations__ for the project :)
|
|
|
|
__Bitcoins:__ bc1qf7v8zty2yz8phulet29wcpxjclvffn5w6ry43w
|
|
|
|
__Ethereum:__ 0xca2FD9C3834694E2cB3db3bf79b3AfB083bA6732
|
|
|
|
![](/src/img/ice-cream.png)
|
|
[CC-BY 4.0 by Vincent Le Moign](https://commons.wikimedia.org/wiki/File:552-soft-ice-cream-2.svg)
|
|
|
|
|
|
## License
|
|
|
|
This program is licensed under GPL v3
|
|
|
|
Copyleft (ɔ) 2021 - Miguel (mickie)
|
|
|
|
See LICENSE file for more information.
|
|
|
|
## TODO
|
|
This boilerplate provides a skeleton to start developing cross-browser web extensions.
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
|
[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/davidnguyen179/web-extension-boilerplate/pulls)
|
|
![ci/cd](https://github.com/davidnguyen179/web-extension-boilerplate/workflows/ci/cd/badge.svg)
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm i
|
|
```
|
|
|
|
**Chrome**
|
|
|
|
```bash
|
|
npm run app:chrome-dev
|
|
```
|
|
|
|
**Edge**
|
|
|
|
```bash
|
|
npm run app:edge-dev
|
|
```
|
|
|
|
**Firefox**
|
|
|
|
```bash
|
|
npm run app:firefox-dev
|
|
```
|
|
|
|
## Production
|
|
|
|
```bash
|
|
npm i
|
|
```
|
|
|
|
```bash
|
|
npm run app:chrome
|
|
```
|
|
|
|
**Edge**
|
|
|
|
```bash
|
|
npm run app:edge
|
|
```
|
|
|
|
**Firefox**
|
|
|
|
```bash
|
|
npm run app:firefox
|
|
```
|
|
|
|
## Load package to browsers
|
|
|
|
**Chrome**
|
|
|
|
1. Go to the browser's URL address bar
|
|
2. Enter `chrome://extensions/`
|
|
3. Switch to "**Developer mode**"
|
|
4. Load extension by clicking "**Load unpacked**"
|
|
5. Browse to `dist/` in source code
|
|
6. Done!
|
|
|
|
Check here for more detail: [https://developer.chrome.com/extensions/getstarted](https://developer.chrome.com/extensions/getstarted)
|
|
|
|
**Edge**
|
|
|
|
1. Go to the browser's URL address bar
|
|
2. Enter `edge://extensions/`
|
|
3. Turn on `Developer mode`
|
|
4. Load extension by clicking "**Load unpacked**"
|
|
5. Browse to `dist/` in source code
|
|
6. Done!
|
|
|
|
**Firefox**
|
|
|
|
1. Go to the browser's URL address bar
|
|
2. Enter `about:debugging#/runtime/this-firefox`
|
|
3. Click **Load Temporary Add-on...**
|
|
4. Browse to your `manifest.json` & click **Open**
|
|
5. Done!
|
|
|
|
Check here for more details: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tr>
|
|
<td align="center"><a href="https://www.dzungnguyen.dev"><img src="https://avatars.githubusercontent.com/u/6290720?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Nguyen</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Code">💻</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Documentation">📖</a> <a href="#design-davidnguyen179" title="Design">🎨</a> <a href="#maintenance-davidnguyen179" title="Maintenance">🚧</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/pulls?q=is%3Apr+reviewed-by%3Adavidnguyen179" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Tests">⚠️</a></td>
|
|
<td align="center"><a href="https://github.com/immint023"><img src="https://avatars.githubusercontent.com/u/38607460?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Minh Ngo</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=immint023" title="Code">💻</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=immint023" title="Tests">⚠️</a></td>
|
|
<td align="center"><a href="http://benlee3.com"><img src="https://avatars.githubusercontent.com/u/35267414?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Harned</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=3BenLee" title="Documentation">📖</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|