From 74a6eda0f3b9813b79d75f17ac3d80b679d25cc9 Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 8 Apr 2021 14:48:42 -0400 Subject: [PATCH] docs: add screenshots and link to CONTRIBUTING.md --- README.md | 42 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 37 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9a18c11..f091611 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ -# Hilbish -🎀 a nice lil shell for lua people made with go and lua +
+

Hilbish

+
+ 🎀 a nice lil shell for lua people made with go and lua +
+
-It is currently in a mostly beta state but is very much usable -(I'm using it right now). +Hilbish is an interactive Unix-like shell written in Go, with the config +and other code written in Lua. +It is currently in a Beta state. Though very fit for daily usage, +updates may contain breaking changes. + +# Screenshots +
+

+

+ +
# Links - **[Documentation](https://github.com/Hilbis/Hilbish/wiki)** +- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See +more screenshots of Hilbish in action # Building Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile. @@ -51,5 +66,22 @@ yay -S hilbish sudo make uninstall ``` +# Contributing +Any kind of contributions to Hilbish are welcome! +Make sure to read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. + +### Special Thanks To +Everyone here who has contributed: + + + + +*Made with [contributors-img](https://contrib.rocks).* + +### Credits +- [This blog post](https://www.vidarholen.net/contents/blog/?p=878) which +is how Hilbish now inserts a newline even if output doesn't have one. + # License -[MIT](LICENSE) +Hilbish is licensed under the MIT license. +[Read here](LICENSE) for more info.