From 8685a80162582a470f6993590de42cf571aabf7c Mon Sep 17 00:00:00 2001 From: mickie Date: Fri, 8 Jan 2021 02:50:15 -0600 Subject: [PATCH] Fix format in README file --- README.md | 58 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index fd37544..5d4e9e5 100644 --- a/README.md +++ b/README.md @@ -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) - - - - # ![img](/img/logo.png) Share Freedom - browser extension Share the current tab on the [fediverse](https://fediverse.party/). -[\![Firefox Add-on](*img/badge-amo.png)](*) +[![Firefox Add-on](images/badge-amo.png)](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) + + + ## Features - + ## Screenshots - - +![img](/img/screenshot_1.png) +![img](/img/screenshot_2.png) - + ## 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). - + ## Contributing @@ -59,30 +61,32 @@ You can contribute in the following ways: - 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 - + ## License This program is licensed under GPL v3 + Copyleft (ɔ) 2021 - Miguel (mickie) + See LICENSE file for more information.