diff --git a/docs/assets/extension-usage/copy-access-token.png b/docs/assets/extension-usage/copy-access-token.png new file mode 100644 index 0000000..00d09a0 Binary files /dev/null and b/docs/assets/extension-usage/copy-access-token.png differ diff --git a/docs/assets/extension-usage/create-access-token.png b/docs/assets/extension-usage/create-access-token.png new file mode 100644 index 0000000..fb1d2f4 Binary files /dev/null and b/docs/assets/extension-usage/create-access-token.png differ diff --git a/docs/assets/extension-usage/extension-screenshot.png b/docs/assets/extension-usage/extension-screenshot.png new file mode 100644 index 0000000..8adedda Binary files /dev/null and b/docs/assets/extension-usage/extension-screenshot.png differ diff --git a/docs/assets/extension-usage/extension-setting-button.png b/docs/assets/extension-usage/extension-setting-button.png new file mode 100644 index 0000000..aabe266 Binary files /dev/null and b/docs/assets/extension-usage/extension-setting-button.png differ diff --git a/docs/assets/extension-usage/extension-setting-page.png b/docs/assets/extension-usage/extension-setting-page.png new file mode 100644 index 0000000..dfcff33 Binary files /dev/null and b/docs/assets/extension-usage/extension-setting-page.png differ diff --git a/docs/assets/extension-usage/shortcut-url.png b/docs/assets/extension-usage/shortcut-url.png new file mode 100644 index 0000000..ce8d0c7 Binary files /dev/null and b/docs/assets/extension-usage/shortcut-url.png differ diff --git a/docs/install-browser-extension.md b/docs/install-browser-extension.md new file mode 100644 index 0000000..4931e97 --- /dev/null +++ b/docs/install-browser-extension.md @@ -0,0 +1,47 @@ +# The Browser Extension of Slash + +Slash provides a browser extension to help you use your shortcuts in the search bar to go to the corresponding URL. + +## How to use + +### Generate an access token + +1. Go to your Slash instance and sign in with your account. + +2. Go to the settings page and click on the "Create" button to create an access token. + + ![](./assets/extension-usage/create-access-token.png) + +3. Copy the access token and save it somewhere safe. + + ![](./assets/extension-usage/copy-access-token.png) + +### Install the extension + +> **Note**: The extension is not published to the Chrome Web Store yet. You can install it from the source code. + +For Chromuim based browsers, you can download the packed extension from the [resources](https://github.com/boojack/slash/tree/main/extension/resources). + +For Firefox, we don't support the Firefox Add-ons platform yet. And we are working on it. + +### Configure the extension + +1. Click on the extension icon and click on the "Settings" button. + + ![](./assets/extension-usage/extension-setting-button.png) + +2. Enter your Slash's domain and paste the access token you generated in the previous step. + + ![](./assets/extension-usage/extension-setting-page.png) + +3. Click on the "Save" button to save the settings. + +4. Click on the extension icon again, you will see a list of your shortcuts. + + ![](./assets/extension-usage/extension-screenshot.png) + +### Use your shortcuts in the search bar + +You can use your shortcuts in the search bar of your browser. For example, if you have a shortcut named `gh` for [GitHub](https://github.com), you can type `s/gh` in the search bar and press `Enter` to go to [GitHub](https://github.com). + +![](./assets/extension-usage/shortcut-url.png) diff --git a/extension/resources/chrome-mv3-prod.zip b/extension/resources/chrome-mv3-prod.zip new file mode 100644 index 0000000..1551a96 Binary files /dev/null and b/extension/resources/chrome-mv3-prod.zip differ