From b6fd615d47cdce0f83c5083c37c148829b99f8aa Mon Sep 17 00:00:00 2001 From: BradBot_1 Date: Sun, 28 Jan 2024 20:42:24 +0000 Subject: [PATCH] Add Dockerhub information --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21d3505..ac51706 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -# Clipboard +# Clipboard ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/bradbot1/clipboard/latest) ![Docker Stars](https://img.shields.io/docker/stars/bradbot1/clipboard) ![Docker Pulls](https://img.shields.io/docker/pulls/bradbot1/clipboard) -A simple static HTTP site that applies a provided string to the users clipboard +A simple static HTTP site that applies a provided string to the users clipboard. + +## Why does this exist? + +It exists so that Sponge7 (minecraft mod framework) ore can send clients to the site in order to replicate sponge10's copy to clipboard functionality. ## How to use -Send the user to a hosted version of index.html with the text to be applied as the parameter +Send the user to a hosted version of index.html with the text to be applied as the parameter. + +For instance, requesting the URL `https://example.com?u=this%20is%20a%20test` will result in the text `this is a test` being placed upon the clipboard. ### Parsing Flags @@ -42,3 +48,18 @@ The following results in the text `copy%20this` being placed upon the clipboard: https://example.com?r=copy this ``` +## Edge Cases + +### No JavaScript + +Clipboard relies upon JavaScript to grab and then parse the provided query from the users URL, without it a simple message stating that they should enable javascript in order to get functionality is is provided. + +### No JavaScript Clipboard API + +If the browser has no clipboard api a message requesting for them to enable it is provided. + +Below this message is the contents that were to be placed inside the clipboard so that they can manually copy said message. + +### No Permission + +If the write to the clipboard fails a message stating that permission is needed and the contents that would have been placed in the clipboard are displayed. \ No newline at end of file