Merge branch 'master' of ssh://gitea.calebfontenot.com:25566/CCF_100/NoMoreAcronyms

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!<br>
+Example:<br>
+![Example](images/example.png)
+<br>
+To run an instance of this bot, define your bot ID in key.json, then run:
+<br>
+`npm install discord.js`
+<br>
+After that, register the bot commands:
+<br>
+`node deploy-commands.js`
+<br>
+And now all you need to do is start the bot!
+<br>
+`node main.ts`