Cleanup metafiles, examples

spacebarchat · Apr 5, 2021 · 04c7275 · 04c7275
1 parent 07efa33
commit 04c7275
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 31 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,9 @@
 # Contributing
+
 Thanks for considering contributing!
 
 A few rules of thumb:
-* Code contributions should match the existing code style. `npm run eslint` could help you check (requires installing ESLint)
-* Check with me before adding/deleting functionality (you can contact me (abalabahaha#9421) [on Discord](https://discord.gg/n2g6BQP))
-* Check the dev branch to make sure someone hasn't worked on the same thing already
-* Pull requests should point to the dev branch, not master
+- Code contributions should match the existing code style. `npm run lint:js` and `npm run lint:ts` could help you check
+- Discuss additions/changes with us [on Discord](https://abal.moe/Eris/invite) before working on them
+- Check the dev branch to make sure someone hasn't worked on the same thing already
+- Pull requests should point to the dev branch, not master
diff --git a/README.md b/README.md
@@ -1,27 +1,27 @@
-Eris [![NPM version](https://img.shields.io/npm/v/eris.svg?style=flat-square)](https://npmjs.com/package/eris)
+Eris [![NPM version](https://img.shields.io/npm/v/eris.svg?style=flat-square&color=informational)](https://npmjs.com/package/eris)
 ====
 
-A NodeJS wrapper for interfacing with Discord.
+A Node.js wrapper for interfacing with Discord.
 
 Installing
 ----------
 
-You will need NodeJS 10.4+. If you need voice support you will also need Python 2.7 and a C++ compiler. Refer to [the Getting Started section of the docs](https://abal.moe/Eris/docs.html) for more details.
+You will need NodeJS 10.4+. If you need voice support you will also need Python 2.7 and a C++ compiler. Refer to [the Getting Started section of the docs](https://abal.moe/Eris/docs) for more details.
 
 ```
 npm install --no-optional eris
 ```
 
-If you need voice support, remove the `--no-optional`
+If you need voice support, remove the `--no-optional`.
 
 Ping Pong Example
 -----------------
 
 ```js
 const Eris = require("eris");
 
-var bot = new Eris("BOT_TOKEN");
-// Replace BOT_TOKEN with your bot account's token
+var bot = new Eris("Bot TOKEN");
+// Replace TOKEN with your bot account's token
 
 bot.on("ready", () => { // When the bot is ready
     console.log("Ready!"); // Log "Ready!"
@@ -45,13 +45,10 @@ More examples can be found in [the examples folder](https://github.com/abalabaha
 Useful Links
 ------------
 
-[The website](https://abal.moe/Eris) includes more detailed information on getting started, as well as documentation for the different components.
-
-[The Discord API channel (#js_eris)](https://abal.moe/Eris/invite) is the best place to get support/contact me.
-
-[The GitHub repo](https://github.com/abalabahaha/eris) has the most updated code.
-
-[The NPM package](https://npmjs.com/package/eris)
+- [The website](https://abal.moe/Eris/) has more details and documentation.
+- [The Discord API channel (#js_eris)](https://abal.moe/Eris/invite) is the best place to get support/contact me.
+- [The GitHub repo](https://github.com/abalabahaha/eris) is where development primarily happens.
+- [The NPM package webpage](https://npmjs.com/package/eris) is, well, the webpage for the NPM package.
 
 License
 -------

diff --git a/examples/basicCommands.js b/examples/basicCommands.js
@@ -1,7 +1,7 @@
 const Eris = require("eris");
 
-// Replace BOT_TOKEN with your bot account's token
-const bot = new Eris.CommandClient("BOT_TOKEN", {}, {
+// Replace TOKEN with your bot account's token
+const bot = new Eris.CommandClient("Bot TOKEN", {}, {
     description: "A test bot made with Eris",
     owner: "somebody",
     prefix: "!"

diff --git a/examples/embed.js b/examples/embed.js
@@ -1,7 +1,7 @@
 const Eris = require("eris");
 
-const bot = new Eris("BOT_TOKEN");
-// Replace BOT_TOKEN with your bot account's token
+// Replace TOKEN with your bot account's token
+const bot = new Eris("Bot TOKEN");
 
 bot.on("ready", () => { // When the bot is ready
     console.log("Ready!"); // Log "Ready!"

diff --git a/examples/intent.js b/examples/intent.js
@@ -1,13 +1,12 @@
 const Eris = require("eris");
 
-const clientOptions = {
+// Replace TOKEN with your bot account's token
+const bot = new Eris("Bot TOKEN", {
     intents: [
         "guilds",
         "guildMessages"
     ]
-};
-const bot = new Eris("BOT_TOKEN", clientOptions);
-// Replace BOT_TOKEN with your bot account's token
+});
 
 bot.on("ready", () => { // When the bot is ready
     console.log("Ready!"); // Log "Ready!"

diff --git a/examples/pingpong.js b/examples/pingpong.js
@@ -1,7 +1,7 @@
 const Eris = require("eris");
 
-const bot = new Eris("BOT_TOKEN");
-// Replace BOT_TOKEN with your bot account's token
+// Replace TOKEN with your bot account's token
+const bot = new Eris("Bot TOKEN");
 
 bot.on("ready", () => { // When the bot is ready
     console.log("Ready!"); // Log "Ready!"

diff --git a/examples/playFile.js b/examples/playFile.js
@@ -1,7 +1,8 @@
 const Eris = require("eris");
 
-const bot = new Eris("BOT_TOKEN");
-// Replace BOT_TOKEN with your bot account's token
+// Replace TOKEN with your bot account's token
+const bot = new Eris("Bot TOKEN");
+
 const playCommand = "!play";
 
 bot.on("ready", () => { // When the bot is ready

diff --git a/examples/reactionButtons.js b/examples/reactionButtons.js
@@ -1,7 +1,7 @@
 const Eris = require("eris");
 
-// Replace BOT_TOKEN with your bot account's token
-const bot = new Eris.CommandClient("BOT_TOKEN", {}, {
+// Replace TOKEN with your bot account's token
+const bot = new Eris.CommandClient("Bot TOKEN", {}, {
     description: "A test bot made with Eris",
     owner: "somebody",
     prefix: "!"