Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axorax/urlmskr
Simple and fast URL masker
https://github.com/axorax/urlmskr
api api-url masker masking url url-api url-mask url-masker url-masking url-shortener urlmasking urlmskr urls urlshortener
Last synced: 6 days ago
JSON representation
Simple and fast URL masker
- Host: GitHub
- URL: https://github.com/axorax/urlmskr
- Owner: Axorax
- Created: 2023-02-21T08:27:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-30T18:45:16.000Z (5 months ago)
- Last Synced: 2024-07-04T08:17:19.958Z (4 months ago)
- Topics: api, api-url, masker, masking, url, url-api, url-mask, url-masker, url-masking, url-shortener, urlmasking, urlmskr, urls, urlshortener
- Language: JavaScript
- Homepage: https://axorax.github.io/urlmskr/
- Size: 164 KB
- Stars: 14
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
English — 中文 — বাংলা — عربي — español
# ❓ About
urlmskr lets you mask links and send encoded messages by changing a link to one that can't be easily read but still redirects to the original. It runs entirely on the frontend, requires no backend server, and stores no data. You can host it anywhere. Support the project on [Patreon!](https://www.patreon.com/axorax) <3
# 🤔 Why?
Using a tool like urlmskr allows you to send a link without revealing the destination site. However, this could lead to receiving links to unwanted sites. To reveal the destination, simply add `+reveal` at the end of the URL. For example: `https://axorax.github.io/urlmskr/hello69+reveal`.
# 💻 Integrate with your project
urlmskr includes libraries for various programming languages in the root directory, named `lib` with the respective language extension. You can paste or import the code into your project. Here’s how to use the JavaScript library:
```html
Example
document.write(urlmskr.mask("https://axorax.github.io")); // Mask URL
document.write("<br>"); // Add empty line
document.write(urlmskr.mask("Hello", "text")); // Mask text
```
---