Update README and package.json files.

This commit is contained in:
mickie 2022-01-13 18:13:11 -06:00
parent d6c31439a8
commit 4ac479a1af
2 changed files with 45 additions and 65 deletions

View File

@ -1,7 +1,6 @@
[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) [![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) [![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) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://gitlab.com/mugcake/fedishare/pulls)
![ci/cd](https://github.com/davidnguyen179/web-extension-boilerplate/workflows/ci/cd/badge.svg)
# ![img](https://gitlab.com/uploads/-/system/project/avatar/16473487/logo-min.png) Fedishare # ![img](https://gitlab.com/uploads/-/system/project/avatar/16473487/logo-min.png) Fedishare
@ -9,33 +8,48 @@ Share the current tab on the [fediverse](https://fediverse.party/).
## Get the extension ## Get the extension
### Gecko
| Firefox Add-ons | Trisquel Add-ons | | Firefox Add-ons | Trisquel Add-ons |
---|--- ---|---
[![img](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a0/Firefox_logo%2C_2019.svg/77px-Firefox_logo%2C_2019.svg.png)](https://addons.mozilla.org/en-US/firefox/addon/fedishare-addon) | [![img](https://trisquel.info/files/avatars/picture-1.png)](https://trisquel.info/en/browser/addons/fedishare) [![img](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a0/Firefox_logo%2C_2019.svg/77px-Firefox_logo%2C_2019.svg.png)](https://addons.mozilla.org/en-US/firefox/addon/fedishare-addon) | [![img](https://trisquel.info/files/avatars/picture-1.png)](https://trisquel.info/en/browser/addons/fedishare)
### Blink (In process)
| Chrome Web Store | Opera addons |
---|---
![img](https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/tbyBjqi7Zu733AAKA5n4.png) | ![img](https://addons-static.operacdn.com/static/header-footer/css/img/opera-addons.png)
## Features ## Features
Simplest add-on for the fediverse. Share web pages right from the toolbar button. Simplest add-on for the fediverse. Share web pages right from the toolbar button.
### Supported services/protocols: ### Supported services/protocols:
- Diaspora - [ ] TODO [Bonfire](https://bonfirenetworks.org/)
- Friendica - [x] [Diaspora](https://diasporafoundation.org/)
- Gnusocial - [ ] TODO [Ecko](https://magicstone.dev/) (Mastodon button)
- Hubzilla / Zap - [ ] TODO [Epicyon](https://epicyon.net/)
- Lemmy - [ ] TODO [Flockingbird](https://flockingbird.social/)
- Mastodon / Misskey - [x] [Friendica](https://friendi.ca/)
- Pleroma - [ ] TODO [Glitch](https://glitch-soc.github.io/docs/) (Mastodon button)
- Socialhome - [x] [Gnusocial](https://gnusocial.network/)
- XMPP - [ ] TODO [GoToSocial](https://docs.gotosocial.org/en/latest/) (Mastodon button)
- [ ] TODO [Groundpolis](https://github.com/Groundpolis/Groundpolis) (Mastodon button)
- [ ] TODO [Hometown](https://github.com/hometown-fork/hometown) (Mastodon button)
- [ ] TODO [Honk](https://humungus.tedunangst.com/r/honk)
- [x] [Hubzilla](https://hubzilla.org/)
- [ ] TODO [Kepi](https://gitlab.com/marnanel/chapeau) (Mastodon button)
- [ ] TODO [Ktistec](https://github.com/toddsundsted/ktistec)
- [x] [Lemmy](https://join-lemmy.org/)
- [x] [Mastodon](https://joinmastodon.org/)
- [x] [Misskey](https://misskey-hub.net/en/) (Mastodon button)
- [ ] TODO [Misty](https://zotlabs.com/misty/) (Hubzilla button)
- [ ] TODO [Mobilizon](https://joinmobilizon.org/en/)
- [ ] TODO [NextCloud](https://nextcloud.com/)
- [x] [Osada](https://codeberg.org/zot/osada) (Hubzilla button)
- [ ] [Pjuu](https://pjuu.com/) *1
- [x] [Pleroma](https://pleroma.social/)
- [ ] TODO [Pump.io](http://pump.io/) *2
- [ ] TODO [Smithereen](https://github.com/grishka/Smithereen)
- [x] [Socialhome](https://socialhome.network/)
- [x] [XMPP](https://xmpp.org/)
- [x] [Zap](https://zotlabs.com/zap/) (Hubzilla button)
- *1 It doesn't have a public API
- *2 Conflicts with the API
## Contributing ## Contributing
@ -60,70 +74,42 @@ This project uses the [Web Extension Boilerplate](https://github.com/davidnguyen
### Prerequisites ### Prerequisites
Gecko - Mozilla-based browser: 59 (or higher)
- Mozilla Firefox 59 (or higher)
**Install all dependencies:** `npm i` **Install all dependencies:** `npm i`
### Development ### Development
##### Chrome - Dev: `npm run app:dev`
- Production: `npm run app:dist`
- Dev: `npm run app:chrome-dev`
- Production: `npm run app:chrome`
##### Edge
- Dev: `npm run app:edge-dev`
- Production: `npm run app:edge`
##### Firefox
- Dev: `npm run app:firefox-dev`
- Production: `npm run app:firefox`
#### Load package to browsers #### Load package to browsers
1. Go to the browser's URL address bar 1. Go to the browser's URL address bar
In Chrome:
2. Enter `chrome://extensions`
In Edge:
2. Enter `edge://extensions`
In Firefox:
2. Enter `about:debugging#/runtime/this-firefox` 2. Enter `about:debugging#/runtime/this-firefox`
3. Click **Load Temporary Add-on...**
In Chrome and Edge: 4. Browse to your `manifest.json` & click **Open**
3. Turn on "**Developer mode**"
4. Load extension by clicking "**Load unpacked**"
5. Browse to `dist/` in source code.
In Firefox:
3. Click **Load Temporary Add-on...**
4. Browse to your `manifest.json` & click **Open**
#### CSS #### CSS
[tailwindcss](https://tailwindcss.com) is the framework used for this project. [tailwindcss](https://tailwindcss.com) is the framework used for this project.
- Dev: `npm run style-dev` - Dev: `npm run style-dev`
- Production: `npm run style` - Production: `npm run style-dist`
Set all css custom in: `public/styles.css`. The `main.css` is generated in `dist`. Set all css custom in: `public/styles.css`. The `main.css` is generated in `dist`.
## Donations ## Donations
If you like the stuff I make and are financially able please consider donating. Your support allows me to dedicate more time to the projects I'm working on. If you like the stuff I make and are financially able please consider donating. Your support allows me to dedicate more time to this and other FOSS projects :D
<a href='https://ko-fi.com/mugcake' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a433a3f45a772abaf5_SupportMe_blue-p-500.png' border='0' alt='Buy Me a Coffee at ko-fi.com' /> <a href='https://ko-fi.com/mugcake' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a433a3f45a772abaf5_SupportMe_blue-p-500.png' border='0' alt='Buy Me a Coffee at ko-fi.com' />
[![img](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/mickie/) [![img](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/mickie/)
__Bitcoin BTC:__ bc1qf7v8zty2yz8phulet29wcpxjclvffn5w6ry43w __Bitcoin BTC:__ TODO
__Ethereum ETH:__ 0xca2FD9C3834694E2cB3db3bf79b3AfB083bA6732 __Ethereum ETH:__ TODO
## License ## License

View File

@ -8,23 +8,17 @@
"code:lint-fix": "eslint --fix '**/**/*.{ts,tsx}'", "code:lint-fix": "eslint --fix '**/**/*.{ts,tsx}'",
"code:prettier": "prettier --write '**/**/*.{ts,tsx}'", "code:prettier": "prettier --write '**/**/*.{ts,tsx}'",
"code:typecheck": "./node_modules/.bin/tsc --noEmit", "code:typecheck": "./node_modules/.bin/tsc --noEmit",
"app:chrome": "rimraf dist && cross-env BROWSER='chrome' webpack --config webpack/webpack.prod.js", "app:dist": "rimraf dist && cross-env BROWSER='firefox' webpack --config webpack/webpack.prod.js",
"app:chrome-dev": "cross-env BROWSER='chrome' webpack --config webpack/webpack.dev.js --watch", "app:dev": "cross-env BROWSER='firefox' webpack --config webpack/webpack.dev.js --watch",
"app:edge": "rimraf dist && cross-env BROWSER='edge' webpack --config webpack/webpack.prod.js",
"app:edge-dev": "cross-env BROWSER='edge' webpack --config webpack/webpack.dev.js --watch",
"app:firefox": "rimraf dist && cross-env BROWSER='firefox' webpack --config webpack/webpack.prod.js",
"app:firefox-dev": "cross-env BROWSER='firefox' webpack --config webpack/webpack.dev.js --watch",
"test:unit": "jest", "test:unit": "jest",
"style-dev": "postcss ./public/css/styles.css -o ./dist/css/main.css", "style-dev": "postcss ./public/css/styles.css -o ./dist/css/main.css",
"style": "NODE_ENV=production postcss ./public/css/styles.css -o ./dist/css/main.css" "style-dist": "NODE_ENV=production postcss ./public/css/styles.css -o ./dist/css/main.css"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://gitlab.com/mugcake/fedishare.git" "url": "git+https://gitlab.com/mugcake/fedishare.git"
}, },
"keywords": [ "keywords": [
"chrome extension",
"microsoft edge extension",
"firefox addon", "firefox addon",
"web extension", "web extension",
"typescript", "typescript",