From 89d0606d068113e80d5377127897da035ec641fd Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Fri, 20 Jan 2023 22:08:16 -0500 Subject: [PATCH] Reword readme to guide users towards using the luau file extension instead of lua --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 96e81338..1bf3cb54 100644 --- a/README.md +++ b/README.md @@ -175,16 +175,20 @@ Lune puts developer experience first, and as such provides type definitions and ## 🏃 Running Lune Scripts -When you've written a script with either a `.lua` or `.luau` extension, you can run it: +After you've written a script file, for example `script-name.luau`, you can run it: ```sh lune script-name ``` -This will look for the script `script-name` in a few locations: +This will look for the file `script-name.luau` in a few locations: - The current directory - The folder `lune` in the current directory, if it exists - The folder `.lune` in the current directory, if it exists -If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name. +If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name.
+ +--- + +**_NOTE:_** _Lune also supports files with the `.lua` extension but using the `.luau` extension is highly recommended._