From 8404361c6a84a997493189c9ea477e28c5a6a9ca Mon Sep 17 00:00:00 2001 From: abhijithvijayan <34790378+abhijithvijayan@users.noreply.github.com> Date: Sun, 4 Jan 2026 04:27:01 +0530 Subject: [PATCH] docs: update readme --- README.md | 84 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 64 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 1d113c1..f8d88ce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

kutt-extension

-

Browser extension for Kutt.it

+

Browser extension for Kutt.it URL shortener

Build @@ -33,28 +33,36 @@ - Free and Open Source - Uses WebExtensions API +## Tech Stack + +- **Bundler**: [Vite](https://vitejs.dev/) 6 +- **UI**: [React](https://react.dev/) 19 +- **Language**: [TypeScript](https://www.typescriptlang.org/) 5.7 +- **Styling**: SCSS with CSS Modules +- **Linting**: ESLint 9 (flat config) + Prettier + ## Browser Support -| [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](https://addons.mozilla.org/firefox/addon/kutt/) | [![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)](CONTRIBUTING.md#for-opera-users) | [![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Yandex](https://raw.github.com/alrra/browser-logos/master/src/yandex/yandex_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![vivaldi](https://raw.github.com/alrra/browser-logos/master/src/vivaldi/vivaldi_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 49 & later ✔ | 52 & later ✔ | 36 & later ✔ | 79 & later ✔ | Latest ✔ | Latest ✔ | Latest ✔ +This extension uses **Manifest V3**. -## How to use +| [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](https://addons.mozilla.org/firefox/addon/kutt/) | [![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)](CONTRIBUTING.md#for-opera-users) | [![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | [![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png)](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 88+ | 109+ | 74+ | 88+ (Chromium) | Latest (Chromium) | -- Download for browser(s) +## Installation - - Chrome: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) - - Firefox: [Kutt :: Add-ons for Firefox](https://addons.mozilla.org/firefox/addon/kutt/) - - Opera [Kutt :: Opera addons](CONTRIBUTING.md#for-opera-users) - - Edge: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) +- **Chrome**: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) +- **Firefox**: [Kutt :: Add-ons for Firefox](https://addons.mozilla.org/firefox/addon/kutt/) +- **Opera**: [Kutt :: Opera addons](CONTRIBUTING.md#for-opera-users) +- **Edge**: [Kutt :: Chrome Web Store](https://chrome.google.com/webstore/detail/kutt/pklakpjfiegjacoppcodencchehlfnpd) -- Generate an API Key from `https://kutt.it/` after signing up. (Settings page) +## How to Use - +1. Generate an API Key from `https://kutt.it/` after signing up (Settings page) -- Paste and Save this `Key` in extension's `options page` when asked. + -
+2. Paste and Save this `Key` in extension's `options page` when asked ## Screenshots @@ -64,15 +72,51 @@ options
-
+## Development + +Ensure you have [Node.js](https://nodejs.org) 20 or later installed. + +```bash +# Install dependencies +npm install + +# Start development server +npm run dev:chrome # For Chrome +npm run dev:firefox # For Firefox + +# Build for production +npm run build:chrome # Build Chrome extension +npm run build:firefox # Build Firefox addon +npm run build # Build for all browsers + +# Linting +npm run lint # Run ESLint +npm run lint:fix # Run ESLint with auto-fix +``` + +### Loading the Extension + +#### Chrome + +1. Navigate to `chrome://extensions` +2. Enable "Developer mode" +3. Click "Load unpacked" +4. Select `extension/chrome` directory + +#### Firefox + +1. Navigate to `about:debugging` +2. Click "This Firefox" +3. Click "Load Temporary Add-on" +4. Select `extension/firefox/manifest.json` ## Note -- Kutt.it API permits **50** URLs shortening per day using the API Key. +- Kutt.it API permits **50** URLs shortening per day using the API Key - **Enable Custom Host** option to use with self-hosted kutt - - Save the self hosted domain in the input (eg: ) - - **Note**: the api endpoint is automatically appended during the api call. -- _Delay at times while shortening might be the issue with Kutt.it API and not with the extension's._ + - Save the self hosted domain in the input (eg: `https://mykutt.it`) + - **Note**: the api endpoint is automatically appended during the api call +- _Delay at times while shortening might be the issue with Kutt.it API and not with the extension's_ ## Contributing and Support @@ -80,6 +124,6 @@ View the Contributing guidelines [here](CONTRIBUTING.md). Original Repo: [thedevs-network/kutt](https://github.com/thedevs-network/kutt) -## Licence +## License Code released under the [MIT License](license).