(master) update readme

README.md

@@ -5,34 +5,33 @@
 
 rust library to build your own shell
 
+[![book](https://img.shields.io/badge/book-website-orange)](#)
+[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](#)
+
 </div>
+<!-- [![build](https://github.com/MrPicklePinosaur/shrs/workflows/Deploy/badge.svg)](https://github.com/MrPicklePinosaur/shrs/actions) -->
 
 ## PROJECT GOALS
 
 - **hackable**: almost every aspect of the shell should be easily customizable and extendable
 - **productive**: shell should encourage and facilitate an efficient workflow
 - **rusty**: implemented in rust down to the syscall level (rustix) and configurable in rust
 
-## TOOD
-
-- [x] pipes
-- [x] file redirection
-- [ ] configuration scheme (config file? builder pattern?)
-- [ ] better logging + error reporting (different ways of displaying exit status)
-- [x] background process + job control (&)
-- [ ] environment variables
-- [x] subshells
-- [ ] signals (^C, ^\, ^Z etc)
-- [ ] completion
-- [ ] history
-- [ ] alias
-- [ ] test suite to ensure posix compliant
-- [ ] control flow
-  - [ ] for
-  - [ ] case
-  - [x] if 
-  - [x] while
-  - [x] until
+## FEATURES
+
+Project is currently very much VIP, below lists the current feature statuses:
+
+| Feature | Status |
+| --- | --- |
+| posix shell | wip |
+| history | mvp |
+| aliases | mvp |
+| completion | mvp |
+| readline | using reedline |
+| hooks | TODO |
+| keybindings | TODO |
+| syntax highlighting | TODO |
+| shell scripts | TODO |
 
 ## RESOURCES
 

design/lang.md

@@ -0,0 +1,5 @@
+
+# Custom Shell Language Design Document
+
+goal 0: investigate if posix shell command language should be kept or if a custom one should be used
+goal 1: design a (possibly non-posix) shell grammar

design/readline.md

@@ -0,0 +1,4 @@
+
+# Readline implementation design doc
+
+Goal: provide a comprehensive readline implementation that is extensible and configurable