diff --git a/README.md b/README.md index b7ba27f..375dc68 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # NoMoreAcronyms -THis is a bot that identifies abbreviations in a sentence and replaces them with the written out phrase!
+This is a bot that identifies abbreviations in a sentence and replaces them with the written out phrase!
Example:
-![Example](images/example.png) \ No newline at end of file +![Example](images/example.png) +
+To run an instance of this bot, define your bot ID in key.json, then run: +
+`npm install discord.js` +
+After that, register the bot commands: +
+`node deploy-commands.js` +
+And now all you need to do is start the bot! +
+`node main.ts`