Holllo/queue
Holllo
/
queue
1
Fork 0
Code Issues 5 Releases 20 Wiki Activity

Rewrite readme.

This commit is contained in:
Bauke 2022-09-27 12:21:53 +02:00
parent 639d2b4462
commit 2f08cc8e26
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 13 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,55 +1,33 @@
# Queue
# Queue ⇥
> A WebExtension for queueing links.
> **Effortless temporary bookmarks.**
[![Get Queue for Firefox](./images/mozilla-addons.png)](https://addons.mozilla.org/firefox/addon/holllo-queue)
[![Get Queue for Chrome](./images/chrome-web-store.png)](https://chrome.google.com/webstore/detail/queue/epnbikemcmienphlfmidkimpjnmohcbl)
[![Get Queue for Edge](./images/microsoft.png)](https://microsoftedge.microsoft.com/addons/detail/queue/aanjampfdpcnhoeglmfefmmegdbifaak)
![Queue 0.2.2](./images/queue-version-0-2-2.png)
![Latest Queue screenshot](./images/queue-version-0-2-2.png)
## Wiki
Want to find out more about Queue? Check out [the wiki].
[the wiki]: https://github.com/Holllo/queue/wiki
Want to find out more about Queue? Check out [the wiki](https://git.bauke.xyz/Holllo/queue/wiki).
## Installation
You can install Queue through the stores linked above, [installing from a file] (see [the Releases page] for a prebuilt version) or building [from source](#development).
You can install Queue through the stores linked above, [manually from a file] (see [the Releases page] for ZIP files) or [from source](#development).
[installing from a file]: https://support.mozilla.org/en-US/kb/find-and-install-add-ons-add-features-to-firefox#w_how-do-i-find-and-install-add-ons
[the Releases page]: https://github.com/Holllo/queue/releases
[manually from a file]: https://support.mozilla.org/en-US/kb/find-and-install-add-ons-add-features-to-firefox#w_how-do-i-find-and-install-add-ons
[the Releases page]: https://git.bauke.xyz/Holllo/queue/releases
## Development
To build Queue you will need [git], [NodeJS] and [pnpm]. Then from a terminal, run the following commands.
To build Queue you will need [git](https://git-scm.com), [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io).
[git]: https://git-scm.com
[NodeJS]: https://nodejs.org
[pnpm]: https://pnpm.io
```sh
# Step 1. Download the repository with Git.
git clone https://github.com/Holllo/queue
cd queue
# Step 2. Install the dependencies.
pnpm install
# Step 3. Start an auto-reloading browser instance for development.
pnpm start
# Step 4. Lint the code and run tests.
pnpm test
# Step 5. Build the WebExtension for production.
# See the web-ext-artifacts directory for output.
pnpm build
```
* Install the dependencies with `pnpm install`.
* Start a separate browser with `pnpm start`.
* Build the WebExtension for production with `pnpm build`.
* Test the code with `pnpm test`.
## License
Queue is open-sourced with the [AGPL-3.0-or-later] license.
[AGPL-3.0-or-later]: https://github.com/Holllo/queue/blob/main/LICENSE
Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Holllo/queue/src/branch/main/LICENSE) for more information.