release: 0.1.0

Author: Rexogamer

CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 (2021-11-29)
+- Initial release
+- This version mostly supports message sending (with a few bugs)

README.md

@@ -1,3 +1,46 @@
 # Termivolt
 
 A simple utility to interact with the Revolt API via the command line.
+
+## Installation
+
+You can install Termivolt via the following methods:
+
+### npm
+
+`npm i -g termivolt`
+
+### Yarn
+
+`yarn global add termivolt`
+
+Yarn 2+ [doesn't support global installs](https://github.com/yarnpkg/berry/issues/821), but you can run Termivolt as a "one-time" command with `yarn dlx`:
+
+`yarn dlx termivolt <command, eg -help>`
+
+(Note that you'll have to append `yarn dlx` every time you want to use Termivolt with this method.)
+
+### pnpm
+
+`pnpm add termivolt --global`
+
+## Usage
+
+Required arguments are in \<angle brackets>, while optional arguments are in [square brackets].
+
+### Sending messages (-send)
+
+To send messages with Termivolt, run `termivolt -send`. Here's the full list of arguments:
+
+`termivolt -send <(--user/--bot)> <channel id (in quotes)> <message content (in quotes)>`
+
+#### Arguments
+
+- `--user/--bot` determines whether the token is a bot or session token. These require different methods of authenticating. Session tokens are currently broken - a fix will be released in the future.
+- The token is provided as-is (ie as copied from Revolt). Bot tokens can be found in your bot settings page - to get session tokens, [follow this guide](https://infi.sh/post/revolt-tokens).
+- The channel ID should be provided as a string (ie in quotes). You can find it in the URL when using Revite (the official Revolt client) or by right-clicking the channel's entry on the channel list and selecting "Copy channel ID".
+- The message itself should be fully encased in double quotes - if you want to use double quotes in the message itself, escape them with a backslash. Note that message formatting may be messed up in some cases - I'm still investigating as to why, but it seems backticks and \newlines break.
+
+### Help (-help)
+
+If you need help, or want to see a list of commands, run `termivolt -help`. This will also show you what version of Termivolt you're using, which is useful for bug reports and such.

src/index.js

@@ -30,7 +30,7 @@ if (command) {
       const data = JSON.parse(await fs.readFile("package.json"));
 
       // send help message
-      console.log(`${chalk.bold.underline.blue(`Termivolt v${data.version}`)}\nTermivolt is a simple utility to interact with the Revolt API via the command line.\n\n${chalk.bold.underline("Commands:\n")}${chalk.bold("-send:")} Sends a message via the specified account.\n${chalk.underline("Example usage:")} termviolt -send <--user/--bot> <token> <channel> <message content (in quotes)>\n${chalk.underline("Notes:")} Formatting may be broken in some cases. In addition, sending via user accounts (using session tokens) currently seems to be broken - a fix will be released in the future.`);
+      console.log(`${styles.title(`Termivolt v${data.version}`)}\nTermivolt is a simple utility to interact with the Revolt API via the command line.\n\n${styles.header("Commands:\n")}${chalk.bold("-send:")} Sends a message via the specified account.\n${chalk.underline("Example usage:")} termviolt -send <(--user/--bot)> <token> <channel> <message content (in quotes)>\n${chalk.underline("Notes:")} Formatting may be broken in some cases. In addition, sending via user accounts (using session tokens) currently seems to be broken - a fix will be released in the future.`);
       break;
     default:
       console.log(

src/lib/send.js

@@ -16,7 +16,7 @@ const sendMsg = function (userType, token, channel, content) {
     return (
       console.log(
         styles.error(
-          "You need to specify a token, a channel ID and the content of the message (all in quotes)."
+          "You need to specify a token, a channel ID and the content of the message (the last two in quotes)."
         )
       ) && process.exit()
     );

src/lib/styles.js

@@ -4,4 +4,8 @@ export default {
   info: chalk.blue,
   error: chalk.bold.red,
   success: chalk.bold.green,
+
+  // -help styles
+  title: chalk.bold.underline.blue,
+  header: chalk.bold.underline
 };