tiny1z - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

		{
		"name": "tiny1z",
		"version": "1.0.1",
		"version": "1.0.2",
		"description": "The Tiny1z API Client is a convenient and lightweight npm package that allows developers to seamlessly integrate the Tiny1z URL Shortener API into their applications. Simplify URL shortening, retrieval, and management with just a few lines of code.",
		@@ -14,3 +14,3 @@ "main": "index.js",
		"url",
		"shotner",
		"url shotner",
		"tiny1z",
		@@ -38,3 +38,5 @@ "tiny",
		"url": "https://github.com/ma7ot/tiny1z"
		}
		},
		"homepage": "https://tiny1z.com"

		}

README.md

		@@ -1,2 +0,7 @@
		# Tiny1z API Client
		<p align="center">
		<a href="https://nextui.org">
		<img width="20%" src="https://tiny1z.com/assets/logo.png" alt="nextui" />
		<h1 align="center">Tiny1z URL Shortner API Client</h1>
		</a>
		</p>

		@@ -18,2 +23,32 @@ The Tiny1z API Client is a powerful and lightweight npm package designed to simplify the integration of Tiny1z URL Shortener API into your applications. This client provides functions to create short URLs, retrieve user-specific URLs, get information about a single URL, and fetch all created URLs.
		```

		## Get a Tiny1z API Key

		To integrate the Tiny1z API into your applications, you'll need a Tiny1z API key. Follow these steps to obtain your API key:

		1. Sign up for a Tiny1z account:
		- If you don't already have a Tiny1z account, sign up by visiting [Tiny1z Signup](https://tiny1z.com/signup).

		2. Access your developer dashboard:
		- Log in to your Tiny1z account and navigate to the [Tiny1z developer dashboard](https://tiny1z.com/account/api-dashboard).

		3. Retrieve your API key:
		- In the developer dashboard, locate the section that provides your API key.
		- Copy the API key; you will need it for making requests to the Tiny1z API.

		Now you are ready to start using the Tiny1z api.

		Example:
		```javascript
		import { createSingleUrl } from 'tiny1z';

		const apiKey = 'your-api-key';
		const data = {
		originalUrl: 'https://www.example.com',
		// additional data...
		};

		const response = await createSingleUrl(data, apiKey);
		```

		## Usage
		@@ -81,3 +116,3 @@

		For detailed information on API endpoints, parameters, and response formats, refer to the [Tiny1z API Documentation](https://tiny1z.com/docs).
		For detailed information on API endpoints, parameters, and response formats, refer to the [Tiny1z API Documentation](https://t1z.li/tiny1z-api).

		@@ -90,6 +125,3 @@ ## Rate and Usage Limits

		If you'd like to contribute to the development of this package, feel free to submit pull requests or open issues on the [GitHub repository](https://github.com/your-username/tiny1z).
		If you'd like to contribute to the development of this package, feel free to submit pull requests or open issues on the [GitHub repository](https://github.com/ma7ot/tiny1z).

		## License

		This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

tiny1z - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics