Skip to content

Commit

Permalink
Improve readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
filiptibell committed Jan 25, 2023
1 parent d34d87d commit 536b24c
Showing 1 changed file with 13 additions and 19 deletions.
32 changes: 13 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,14 @@

<div align="center">
<h1> Lune πŸŒ™ </h1>

<div align="center">
<a href="https://crates.io/crates/lune"><img src="https://img.shields.io/crates/v/lune.svg?label=Version" alt="Current Lune library version" /></a>
<a href="https://github.com/filiptibell/lune/actions"><img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/ci.yaml" alt="CI status" /></a>
<a href="https://github.com/filiptibell/lune/actions"><img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/release.yaml" alt="Release status" /></a>
<a href="https://github.com/filiptibell/lune/blob/main/LICENSE.txt"><img src="https://img.shields.io/github/license/filiptibell/lune.svg?label=License&color=informational" alt="Current Lune library version" /></a>
</div>

<br />

A standalone <a href="https://luau-lang.org">Luau</a> script runner

πŸš€ Use the ergonomics and readability of Luau for your shell scripts πŸš€

<div>
<a href="https://crates.io/crates/lune"><img src="https://img.shields.io/crates/v/lune.svg?label=Version" alt="Current Lune library version" />
<a href="https://github.com/filiptibell/lune/actions"><img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/ci.yaml" alt="CI status" />
<a href="https://github.com/filiptibell/lune/actions"><img src="https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/release.yaml" alt="Release status" />
<a href="https://github.com/filiptibell/lune/blob/main/LICENSE.txt"><img src="https://img.shields.io/github/license/filiptibell/lune.svg?label=License&color=informational" alt="Current Lune library version" />
</div>
<br /> A standalone <a href="https://luau-lang.org">Luau</a> script runner
<br /> πŸš€ Use the ergonomics and readability of Luau for your shell scripts πŸš€
</div>

<hr />
Expand All @@ -35,7 +29,7 @@ You can also download pre-built binaries for most systems directly from the GitH

## ✏️ Writing Lune Scripts

Check out the examples on how to write a script in the [.lune](.lune) folder ! <br>
Check out the examples on how to write a script in the [.lune](.lune) folder ! <br />
A great starting point and walkthrough of Lune can be found in the [Hello, Lune](.lune/hello_lune.luau) example.

<details>
Expand Down Expand Up @@ -196,7 +190,7 @@ An example of these settings can be found in the [.vscode](.vscode) folder in th
2. Use either `std = "luau+lune"`, or `std = "roblox+lune"` if your project also contains Roblox-specific code, in your `selene.toml` configuration file

</details>
<br>
<br />

**_NOTE:_** _It is highly recommended to add any type definition files to your `.gitignore` and to only download them using these commands, since this guarantees that you have type definitions compatible with your installed version of Lune._

Expand All @@ -216,16 +210,16 @@ This will look for the file `script-name.luau` in a few locations:
- 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. <br>
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. <br />

## πŸ’­ Additional Commands

```sh
lune --list
```

Lists all scripts found in `lune` or `.lune` directories, including description comments if they exist. <br>
If both `lune` and `.lune` directories exist, only the former will have its scripts listed, which is consistent with the behavior of running scripts.
Lists all scripts found in `lune` or `.lune` directories, including any top-level description comments. <br />
Lune description comments are always written at the top of a file and start with a lua-style comment arrow (`-->`).

---

Expand Down

0 comments on commit 536b24c

Please sign in to comment.