Add a bunch of stuff to the Readme.

This commit is contained in:
Bauke 2020-11-20 14:58:32 +01:00
parent 5966de4307
commit 6f88a5f8b8
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
4 changed files with 65 additions and 0 deletions

View File

@ -2,6 +2,33 @@
> A WebExtension for queueing links.
[![Queue on AMO](https://img.shields.io/amo/v/holllo-queue)](https://addons.mozilla.org/firefox/addon/holllo-queue)
![Queue 0.1.5](./docs/screenshots/queue-version-0-1-5.png)
## Installation
* Queue is available [through AMO](https://addons.mozilla.org/firefox/addon/holllo-queue/).
* Or via manual installation by either building from source yourself or using a prebuilt version available in the [Releases page](https://github.com/Holllo/queue/releases).
## Development
[Node.js LTS](https://nodejs.org) and [Yarn](https://yarnpkg.com/) are required to build and develop the extension. As well as a relatively recent version of [Firefox](https://www.mozilla.org/firefox/).
To get started, [a script](https://github.com/Holllo/queue/blob/main/docs/scripts/clone-and-install.sh) to clone the repository and install the dependencies is available. You can download and execute the script in one go with the following command.
```sh
sh -c "$(curl -fsSL https://github.com/Holllo/queue/blob/main/docs/scripts/clone-and-install.sh)"
```
To test the extension, run `yarn start:firefox`.
To develop and reload the extension on changes, run `yarn watch` in one terminal and `yarn start:firefox` in another.
## Changelog
All changes made can be found for every version in [Releases page](https://github.com/Holllo/queue/releases).
## License
Licensed under [AGPL-3.0-or-later](https://github.com/Holllo/queue/blob/main/LICENSE).

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

View File

@ -0,0 +1,38 @@
#!/usr/bin/env bash
set -e
required_commands=(
"git"
"yarn"
)
for cmd in ${required_commands[*]}; do
if ! command -v "$cmd" &> /dev/null; then
echo "Command \`$cmd\` could not be found and is required for this script to function."
exit
fi
done
echo "Cloning git repository"
echo "$ git clone 'https://github.com/Holllo/queue'"
git clone 'https://github.com/Holllo/queue'
echo
echo "Changing directory to the git repository"
echo "$ cd 'queue'"
cd 'queue'
echo
echo "Installing the dependencies"
echo "$ yarn --silent"
echo
yarn --silent
echo
echo "Building the extension"
echo "$ yarn build"
yarn build
echo
echo "Done! Check 'queue/build' for the output."