BREAKING CHANGE: interactions support

egorprnn · Aug 6, 2021 · b46d830 · b46d830
1 parent bb633ce
commit b46d830
Show file tree

Hide file tree

Showing 44 changed files with 27,515 additions and 1,133 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -30,7 +30,7 @@
     ],
     "quotes": [
       "error",
-      "double"
+      "single"
     ],
     "semi": [
       "error",

diff --git a/.github/demo.gif b/.github/demo.gif
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,10 @@
 .idea
+.github
 node_modules
 lib
 build
+scripts
+.gitignore
+.eslintrc.json
+babel.config.json
+tsconfig.json
diff --git a/README.md b/README.md
@@ -9,13 +9,58 @@
     <img src="https://badge.fury.io/js/discord.js-pages.svg" alt="npm version" height="18">
   </a>
 
-| 📖 [Documentation](docs/introduction.md) | 🤖 [Examples](docs/examples) |
-| --------------------------------------- | ---------------------------- |
+| 📖 [Documentation](https://mrzillagold.github.io/discord.js-pages/index.html) |
+| ---------------------------------------------------------------------------- |
 
 </p>
 
 ### Install 📦
 `npm i discord.js-pages`
 
+### Usage 📦
+```js
+import { PagesBuilder } from 'discord.js-pages';
+import { Client, MessageEmbed } from 'discord.js';
+
+const client = new Client({
+    intents: [
+        'GUILDS'
+    ]
+});
+
+// Middleware is useful in bots with modular commands
+client.on('interactionCreate', (interaction) => {
+    pagesManager.middleware(interaction);
+
+    message.pagesBuilder()
+        .setTitle('Global title')
+        .setPages([
+            new MessageEmbed()
+                .setDescription('First page'),
+            new MessageEmbed()
+                .setDescription('Second page')
+        ])
+        .addField('Global field', 'discord.js-pages', true)
+        .setColor('GREEN')
+        .build();
+});
+
+client.on('interactionCreate', (interaction) => {
+    new PagesBuilder(interaction)
+        .setTitle('Global title')
+        .setPages([
+            new MessageEmbed()
+                .setDescription('First page'),
+            new MessageEmbed()
+                .setDescription('Second page')
+        ])
+        .addField('Global field', 'discord.js-pages', true)
+        .setColor('GREEN')
+        .build();
+});
+
+client.login(process.env.TOKEN);
+```
+
 ### Demo 🎥
-<img src="https://github.com/MrZillaGold/discord.js-pages/raw/master/docs/demo.gif" height="200">
+<img src="https://github.com/MrZillaGold/discord.js-pages/raw/master/.github/demo.gif" height="500">