link-shortener
Advanced tools
Comparing version 1.1.5 to 1.2.0
{ | ||
"name": "link-shortener", | ||
"version": "1.1.5", | ||
"version": "1.2.0", | ||
"description": "An easy to use Link shortner module. This module uses the cutt.ly API to shorten your links, you can also add custom titles for your links!", | ||
@@ -14,3 +14,7 @@ "main": "index.js", | ||
"valid-url": "^1.0.9" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/RobertCodez1/Link-Shortener" | ||
} | ||
} |
@@ -6,2 +6,14 @@ ## Link Shortener | ||
- Custom and Unique Link title's are possible to create/add to your shortened link | ||
### Functions | ||
`.Shorten([URL to shorten], [Optional Title for the shortened link])` | ||
The **first parameter** of this function has to be the **URL that you would like to shorten**. If it isn't a valid URL or if you didn't enter a URL, you will see an error show up in the console. | ||
The **second parameter** of this function can be left empty if you don't want a custom link title, if you want a custom title, you can enter a **string** as the second parameter. To check if the title is taken by another user, you have to add a check in your code (example given below). | ||
**Example of a custom link title:** | ||
https://cutt.ly/CustomLink | ||
**Example of a random link title:** | ||
https://cutt.ly/wXyH2 | ||
### Usage | ||
@@ -24,3 +36,7 @@ | ||
### Support me! | ||
I would love to make more packages for the community, if you would like to help me out, and contribute to my work, do consider donating here: https://www.buymeacoffee.com//robertcodez | ||
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
4271
0
1
41
0