93 lines
1.9 KiB
Markdown
93 lines
1.9 KiB
Markdown
#  Share Freedom - browser extension
|
|
|
|
Share the current tab on the [fediverse](https://fediverse.party/).
|
|
|
|
[](https://addons.mozilla.org/en-US/firefox/addon/share-freedom/)
|
|
|
|
|
|
# Table of Contents
|
|
|
|
1. [Features](#features)
|
|
2. [Screenshots](#screenshots)
|
|
3. [Build](#build)
|
|
4. [Contributing](#contrib)
|
|
1. [Bug reports](#bug)
|
|
2. [Pull request](#pull)
|
|
5. [Invite an ice cream](#donate)
|
|
6. [License](#license)
|
|
|
|
|
|
<a id="features"></a>
|
|
|
|
## Features
|
|
|
|
|
|
<a id="screenshots"></a>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
<a id="build"></a>
|
|
|
|
## Build
|
|
|
|
You need Node.js/npm to use the command line tool web-ext
|
|
|
|
`npm install --global web-ext`
|
|
|
|
then, use the next command to generate the package (.zip file)
|
|
|
|
`web-ext build`
|
|
|
|
See [web-ext page](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/).
|
|
|
|
**Optional:** Add-ons Linter by Mozilla
|
|
|
|
`npm install -g addons-linter`
|
|
|
|
See [repo](https://github.com/mozilla/addons-linter).
|
|
|
|
|
|
<a id="contrib"></a>
|
|
|
|
## Contributing
|
|
|
|
You can contribute in the following ways:
|
|
|
|
- Finding and reporting bugs
|
|
- Contributing code to the project by fixing bugs or implementing features
|
|
|
|
|
|
<a id="bug"></a>
|
|
|
|
### 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.
|
|
|
|
|
|
<a id="pull"></a>
|
|
|
|
### Pull request
|
|
|
|
Please use clean, concise titles for your pull requests.
|
|
|
|
|
|
<a id="donate"></a>
|
|
|
|
## Invite an ice cream
|
|
|
|
|
|
<a id="license"></a>
|
|
|
|
## License
|
|
|
|
This program is licensed under GPL v3
|
|
|
|
Copyleft (ɔ) 2021 - Miguel (mickie)
|
|
|
|
See LICENSE file for more information.
|
|
|