added API guide to readme

1 files changed, 5 insertions, 1 deletions

diff --git a/README.md b/README.md
index 1688d84..2d04c3a 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,14 @@ To update Lunar Shell pull the repo and run the install script again.
 
 With the robust and ever growing Lua API that Lunar Shell has builtin, not only can you create powerful shell scripts to automate your workflow but also reap the benefits of having an easy to understand scripting language embedded into your command line.
 
-To run a Lua script with Lunar Shell just type the name of the lua file you want to run followed by any arguments you want to pass to the script. Lunar Shell will automatically search the current working directory as well as the ~/.lush/scripts directory and then execute the file if it locates a match.
+To run a Lua script with Lunar Shell just type the name of the lua file you want to run followed by any arguments you want to pass to the script. Lunar Shell will automatically search the current working directory as well as the ```~/.lush/scripts``` directory and then execute the file if it locates a match.
 
 Lunar Shell also entirely supports the Lua interpreter, running on version 5.4. This means you can also just run Lua programs you write like native apps in your shell, no need to make any calls to the API.
 
+## Using the Lunar Shell Lua API
+
+Using the Lunar Shell API to make your own scripts is super simple. Upon installing Lunar Shell you can find an example script located at ```~/.local/scripts/example.lua``` this script acts as a self docummenting guide on how to use the API. Every function that exists in the API can be found in the example script along with helpful comments to explain what the functions do.
+
 ## Contributing
 
 - Before opening an issue or a PR please check out the [contributing guide](https://github.com/BanceDev/lush/blob/main/CONTRIBUTING.md).