From 7b746287327afc6220e2560aca08e200b4fc8bba Mon Sep 17 00:00:00 2001 From: itsMapleLeaf <19603573+itsMapleLeaf@users.noreply.github.com> Date: Sat, 23 Jul 2022 00:16:27 -0500 Subject: [PATCH] add link to template + other tweaks --- .../app/routes/guides/getting-started.md | 21 +++++++++++++------ .../website/app/routes/guides/use-instance.md | 1 + 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/packages/website/app/routes/guides/getting-started.md b/packages/website/app/routes/guides/getting-started.md index 1c8c583..0d156f9 100644 --- a/packages/website/app/routes/guides/getting-started.md +++ b/packages/website/app/routes/guides/getting-started.md @@ -7,11 +7,15 @@ meta: # Getting Started -This guide assumes some familiarity with JavaScript, [React](https://reactjs.org), [Discord.js](https://discord.js.org) and the [Discord API](https://discord.dev). Keep these pages as reference if you need it. +These guides assume some familiarity with JavaScript, [React](https://reactjs.org), [Discord.js](https://discord.js.org) and the [Discord API](https://discord.dev). Keep these pages as reference if you need it. -**Note:** Ensure your project has support for running code with JSX. I recommend using [esno](https://npm.im/esno). +## Setup from template -## Install +[Use this starter template](https://github.com/itsMapleLeaf/reacord-starter) to get off the ground quickly. + +## Adding to an existing project + +Install Reacord and dependencies: ```bash # npm @@ -24,12 +28,10 @@ yarn add reacord react discord.js pnpm add reacord react discord.js ``` -## Setup - Create a Discord.js client and a Reacord instance: ```js -// main.js +// main.jsx import { Client } from "discord.js" import { ReacordDiscordJs } from "reacord" @@ -42,3 +44,10 @@ client.on("ready", () => { await client.login(process.env.BOT_TOKEN) ``` + +To use JSX in your code, run it with [tsx](https://npm.im/tsx): + +```bash +npm install tsx +tsx main.tsx +``` diff --git a/packages/website/app/routes/guides/use-instance.md b/packages/website/app/routes/guides/use-instance.md index dcfc340..d751e1a 100644 --- a/packages/website/app/routes/guides/use-instance.md +++ b/packages/website/app/routes/guides/use-instance.md @@ -1,4 +1,5 @@ --- +order: 5 meta: title: useInstance description: Using useInstance to get the current instance within a component