diff --git a/README.md b/README.md index 6f15015..375dc68 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# NoMoreAcroyms +# NoMoreAcronyms +This is a bot that identifies abbreviations in a sentence and replaces them with the written out phrase!
+Example:
+![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` diff --git a/images/NoMoreAcronyms.png b/images/NoMoreAcronyms.png new file mode 100644 index 0000000..844687d Binary files /dev/null and b/images/NoMoreAcronyms.png differ diff --git a/images/example.png b/images/example.png new file mode 100644 index 0000000..fbff2b4 Binary files /dev/null and b/images/example.png differ