diff --git a/README.md b/README.md index 98fa338..fd37544 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,88 @@ # Table of Contents -1. [Share Freedom - browser extension](#orgf828cd1) - -![img](/img/logo.png) +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) - + -# Share Freedom - browser extension +# ![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)](*) + + + + +## Features + + + + +## Screenshots + + + + + + + +## 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 + +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 + + + + +## License + +This program is licensed under GPL v3 +Copyleft (ɔ) 2021 - Miguel (mickie) +See LICENSE file for more information. diff --git a/img/screenshot_1.png b/img/screenshot_1.png new file mode 100644 index 0000000..6a59a89 Binary files /dev/null and b/img/screenshot_1.png differ diff --git a/img/screenshot_2.png b/img/screenshot_2.png new file mode 100644 index 0000000..4f19a52 Binary files /dev/null and b/img/screenshot_2.png differ