devol
/
condividi-link-fediverso-firefox
mirror of https://gitlab.com/mickie1/share-freedom-extension
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix format in README file

This commit is contained in:
mickie 2021-01-08 02:50:15 -06:00
parent f54a14c8e3
commit 8685a80162
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,55 +1,57 @@
# Table of Contents
1. [/img/logo.png Share Freedom - browser extension](#org9836160)
1. [Features](#org5374026)
2. [Screenshots](#orgd90208f)
3. [Build](#org005bc4f)
4. [Contributing](#org3c92334)
1. [Bug reports](#org73187d2)
2. [Pull request](#orgcc46432)
5. [Invite an ice cream](#orga3b440b)
6. [License](#orgdc5ec85)
<a id="org9836160"></a>
# ![img](/img/logo.png) Share Freedom - browser extension # ![img](/img/logo.png) Share Freedom - browser extension
Share the current tab on the [fediverse](https://fediverse.party/). Share the current tab on the [fediverse](https://fediverse.party/).
[\![Firefox Add-on](*img/badge-amo.png)](<https://addons.mozilla.org/en-US/firefox/addon/share-freedom>*) [![Firefox Add-on](images/badge-amo.png)](https://addons.mozilla.org/en-US/firefox/addon/share-freedom/)
<a id="org5374026"></a> # 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 ## Features
<a id="orgd90208f"></a> <a id="screenshots"></a>
## Screenshots ## Screenshots
<file:///img/screenshot_1.png_> ![img](/img/screenshot_1.png)
<file:///img/screenshot_2.png_> ![img](/img/screenshot_2.png)
<a id="org005bc4f"></a> <a id="build"></a>
## Build ## Build
You need Node.js/npm to use the command line tool web-ext You need Node.js/npm to use the command line tool web-ext
`npm install --global web-ext` `npm install --global web-ext`
then, use the next command to generate the package (.zip file) then, use the next command to generate the package (.zip file)
`web-ext build` `web-ext build`
See [web-ext page](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/). See [web-ext page](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/).
**Optional:** Add-ons Linter by Mozilla **Optional:** Add-ons Linter by Mozilla
`npm install -g addons-linter` `npm install -g addons-linter`
See [repo](https://github.com/mozilla/addons-linter). See [repo](https://github.com/mozilla/addons-linter).
<a id="org3c92334"></a> <a id="contrib"></a>
## Contributing ## Contributing
@ -59,30 +61,32 @@ You can contribute in the following ways:
- Contributing code to the project by fixing bugs or implementing features - Contributing code to the project by fixing bugs or implementing features
<a id="org73187d2"></a> <a id="bug"></a>
### Bug reports ### 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. 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="orgcc46432"></a> <a id="pull"></a>
### Pull request ### Pull request
Please use clean, concise titles for your pull requests. Please use clean, concise titles for your pull requests.
<a id="orga3b440b"></a> <a id="donate"></a>
## Invite an ice cream ## Invite an ice cream
<a id="orgdc5ec85"></a> <a id="license"></a>
## License ## License
This program is licensed under GPL v3 This program is licensed under GPL v3
Copyleft (ɔ) 2021 - Miguel (mickie) Copyleft (ɔ) 2021 - Miguel (mickie)
See LICENSE file for more information. See LICENSE file for more information.