initial commit

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed12716
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Lunar Shell
+
+Lunar Shell (lush) is an open source unix shell with a single goal in mind. That goal is to offer the ability to write shell scripts for your operating system entirely in Lua. The Lua scripting language has many powerful features that allow for more control in the hands of the user to automate tasks on their machine.
+
+## Compiling
+
+Clone the repo and run the install script.
+
+```
+git clone https://github.com/BanceDev/lush.git
+cd lush
+sh install.sh
+```
+
+For future compiles just run ```make``` from the root directory. If you change the premake5.lua file rebuild the makefiles with ```premake5 gmake```.
+
+## Releases
+
+Binary builds are available from [releases](https://github.com/BanceDev/lush/releases).
+
+## Contributing
+
+- For bug reports and feature suggestions please use [issues](https://github.com/BanceDev/lush/issues).
+- If you wish to contribute code of your own please submit a [pull request](https://github.com/BanceDev/lush/pulls).
+- Note: It is likely best to submit an issue before a PR to see if the feature is wanted before spending time making a commit.
+- All help is welcome!