From afa40dd1a13b168abe26b7a42f02795b0f758a6e Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Tue, 14 Dec 2021 10:19:11 -0400 Subject: [PATCH] docs: update readme with new description --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 354f05a..0fcbe9a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-

+
🌺 The flower shell. A comfy and nice little shell for Lua users and fans!

@@ -14,9 +14,12 @@

-Hilbish is a new, Unix-like shell which uses Lua as its configuration language. -It's decently fast for interactive use and includes a bunch of utility functions and features -to make your life in a terminal easier. +Hilbish is a Unix-y shell which uses Lua for scripting. Things like the prompt, +general configuration and such are done with Lua. + +For interactive use, it uses a library to run sh which works on all +platforms Hilbish can be compiled for. It can also act as a Lua REPL if you want +it to be. # Screenshots
@@ -102,7 +105,7 @@ After you did all that, run `sudo make install` to install Hilbish globally. Any kind of contributions to Hilbish are welcome! Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. -##### Thanks to everyone below who's contributed! +**Thanks to everyone below who's contributed!** @@ -110,8 +113,5 @@ Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. *Made with [contributors-img](https://contrib.rocks).* # License -Hilbish is licensed under the MIT license! -Read the [license here](LICENSE) for more info. - -Images in the [assets](assets/) folder are under CC-BY-SA 4.0 - +Hilbish is licensed under the [MIT license](LICENSE). +[Images and assets](assets/) are licensed under CC-BY-SA 4.0