README.md

discordly.City

discordly City officially NPM Package to make it easier to develop discordly City API

⚙ Installation

npm install discordly.city

📜 Example

• AutoPost Example A full working example can be found in example/index.js

const { Client } = require('discord.js');
const { DiscordlyCity } = require('discordly.city');

const myBot = new Client(/*{....}*/);
const discordlyCity = new DiscordlyCity('YOUR_DISCORDLY_CITY_TOKEN', myBot);

myBot.login('YOUR_DISCORD_TOKEN');

discordlyCity.autoPost((err, data) =>
{
    if (err)
    {
        console.error(err);
    }
    else
    {
        console.log('Discordly City Status Updated.');
    }
});

myBot.on('ready', () =>
{
    console.log('I am ready!');
});

• Widget Example

const { Widget } = require('discordly.city');

const myWidget = new Widget();
const widgetUrl = myWidget.generateUrl('user' /* Widget Type */, 'YOUR_DISCORD_ID', 'YOUR_WIDGET_THEME'); // Theme is an optional argument.

console.log(widgetUrl); // ex. https://api.discordly.city/api/v1/user/widget/theme-1/488958506280550402

✨ Features

• Post your bot guilds count to discordly City api Automaticly
• Get your User/Bot/Guild Widget
  

📃 Documents

There is not much to say at the moment, but you will be able to pass an optional object for more functionality such as Interval timer, and more.

const options = 
    {
        interval: 300000, // Interval timer in miliseconds
        postOnStart: true // or false, Automaticly post data whenever the client is ready.
    }

const discordlyCity = new discordlyCity('YOUR_DISCORDLY_CITY_TOKEN', myBot, options);

MIT License