# About
`@sodiumlabs/plume-url` is a module that allows you to easily use Plume URL. See the [module docs](https://docs.sodiumlabs.xyz/docs/packages/plume-url/stable), and the [API docs](https://url.sodiumlabs.xyz/docs) to understand how to use it.
# Installation
```sh
npm install @sodiumlabs/plume-url
```
# Links
- [Plume URL](https://url.sodiumlabs.xyz)
- [Plume URL documentation](https://url.sodiumlabs.xyz/docs)
- [Module documentation](https://docs.sodiumlabs.xyz/docs/packages/plume-url/stable)
- [Discord server](https://discord.gg/8PDXWSHH7k)
- [GitHub](https://github.com/sodium-labs/plume-url.js)
- [npm](https://npmjs.com/package/@sodiumlabs/plume-url)
- [Sodium Labs](https://sodiumlabs.xyz)
# Examples
If you are developing a Discord bot using `discord.js`, here is how to use Plume URL:
```js
const { Client } = require("discord.js");
const { PlumeURL } = require("@sodiumlabs/plume-url");
// Your discord.js client
const client = new Client({
/* ... */
});
// Attach PlumeURL to your client
client.plumeURL = new PlumeURL({ apiKey: "YOUR-API-KEY" });
```
You can now use Plume URL anywhere in your bot.
For example, in a slash command:
```js
const userId = "619838036846575617";
// Create a new URL
const data = await client.plumeURL.createURL({
url: "https://google.com",
customId: userId, // The custom ID allows your users to retrieve their URLs later
});
console.log(data);
// Search for the URLs you created
// You can filter by custom ID if needed
const urls = await client.plumeURL.search({ limit: 5, customId: userId });
console.log(urls);
```
# Documentation
Plume URL provides two main resources for documentation:
- **API Reference:**
[Plume URL Documentation](https://url.sodiumlabs.xyz/docs)
This documentation covers all available endpoints, types, and detailed comments for the API.
- **Module Reference:**
[Module Documentation](https://docs.sodiumlabs.xyz/docs/packages/plume-url/stable)
This documentation explains how to use the `@sodiumlabs/plume-url` npm package, with all available methods and types.
For most use cases, you'll want to refer to the [`PlumeURL` class page](https://docs.sodiumlabs.xyz/docs/packages/plume-url/stable/PlumeURL:Class), which lists all available methods for interacting with the API through this module.
# Help
If you don't understand something in the documentation, are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [Discord Server](https://discord.gg/8PDXWSHH7k).
