CONTRIBUTING.md

@@ -1,47 +1,10 @@
-# Contributing to Hilbish
+# Contributing
-Thanks for your interest in contributing to Hilbish! No matter if it's
-a new feature, documentation, or bug report, we appreciate any kind
-of contributions.
 
-This file is a document to state the steps/rules to take when making
+## Pull Request Process
-a contribution. Be sure to read through it.
 
-## Bug Reports // Feature Requests
+1. Ensure that any new install or build dependencies are documented in the README.md and PR request.
-Use GitHub Issues to report any bugs or to request any features
+2. Update the README.md with details of changes to the shell, this includes useful file locations
-that may be useful to *anyone* else.
+   and breaking changes.
-
+3. The versioning scheme we use is [SemVer](http://semver.org/) and the commit scheme we use is 
-Check [currently open issues](https://github.com/Hilbis/Hilbish/issues)
+   [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please document any 
-and [closed ones](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aclosed) to make sure someone else hasn't already made the issue.
+   backwards incompatible changes and be sure to name your commits correctly.
-
-For bug reports, be sure to include:
-- Hilbish Version (`hilbish -v`)
-- Ways to reproduce
-
-## Code
-For any code contributions (Lua and/or Go), you should follow these
-rules:  
-- Tab size 4 indentation
-- In Lua prefer no braces `()` if the function takes 1 argument
-- Use camelCase for function names
-
-### Making the Pull Request
-1. Ensure that any new install or build dependencies are documented in
-the README.md and PR request.
-
-2. Say in the pull request details the changes to the shell,
-this includes useful file locations and breaking changes.
-
-3. The versioning scheme we use is [SemVer](http://semver.org/) and the
-commit scheme we use is
-[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
-Please document any backwards incompatible changes and be sure to name
-your commits correctly.
-
-4. Finally, make the pull request to the **dev** branch.
-
-## Finding Issues to Contribute to
-You can check out the [help wanted](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+)
-labels to figure out what we need your help working on.  
-
-The [up for grabs](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+) labeled issues are low hanging fruit that should be
-easy for anyone. You can use this to get started on contributing!

README.md

@@ -1,29 +1,11 @@
-<div align="center">
+# Hilbish
-	<h1>Hilbish</h1>
+🎀 a nice lil shell for lua people made with go and lua
-	<blockquote>
-	🎀 a nice lil shell for lua people made with go and lua
-	</blockquote><p align="center">
-		<a href="https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22"><img src="https://img.shields.io/github/issues/Hilbis/Hilbish/help%20wanted?color=green" alt="help wanted"></a>
-		<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
-	</p>
-</div>
 
-Hilbish is an interactive Unix-like shell written in Go, with the config
+It is currently in a mostly beta state but is very much usable
-and other code written in Lua.  
+(I'm using it right now).
-It is currently in a Beta state. Though very fit for daily usage,
-updates may contain breaking changes.
-
-# Screenshots
-<div align="center">
-<img src="gallery/default.png"><br><br>
-<img src="gallery/terminal.png"><br><br>
-<img src="gallery/pillprompt.png">
-</div>
 
 # 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.  
@@ -69,22 +51,5 @@ 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:
-<a href="https://github.com/Hilbis/Hilbish/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" />
-</a>
-
-*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
-Hilbish is licensed under the MIT license.  
+[MIT](LICENSE)
-[Read here](LICENSE) for more info.

TODO.md

@@ -0,0 +1,10 @@
+- [x] Configuration
+  - [x] Make default config if missing
+- [x] Tab completion
+- [x] Custom commands via the shell
+- [ ] Confirmed windows support
+- [ ] Readme badges
+- [x] Hooks
+- [x] Aliases
+- [ ] hlua (hilbish lua) - 100% lua in the hilbish interactive shell, cuz why not
+- [ ] Petals (name of plugins)