Improved README.

Author: Paebbels

README.md

@@ -19,6 +19,68 @@
 
 A set of helpers to implement a text user interface (TUI) in a terminal.
 
+## Features
+* Colored command line outputs based on colorama
+* Message classification in fatal, error, warning, normal, quiet, ...
+* Get information like terminal dimensions from underlying terminal window
+
+
+## Simple Terminal Application
+
+This is a minimal terminal application example which inherits from `LineTerminal`.
+
+```python
+from pyTerminalUI import LineTerminal
+
+class Application(LineTerminal):
+  def __init__(self):
+    super().__init__(verbose=True, debug=True, quiet=False)
+
+  def run(self):
+    self.WriteNormal("This is a simple application.")
+    self.WriteWarning("This is a warning message.")
+    self.WriteError("This is an error message.")
+
+# entry point
+if __name__ == "__main__":
+  Application.versionCheck((3,6,0))
+  app = Application()
+  app.run()
+  app.exit()
+```
+
+## Complex Terminal Application
+
+This example hands over the terminal instance to a submodule, which implements
+`ILineTerminal`, so the submodule can also use the terminal's writing methods.
+
+```python
+from pathlib      import Path
+from pyTerminalUI import LineTerminal, ILineTerminal
+
+class SubModule(ILineTerminal):
+  def __init__(self, configFile, terminal):
+    super().__init__(terminal)
+
+    if not configFile.exists():
+      self.WriteError("Config file '{0!s}' not found.".format(configFile))
+
+
+class Application(LineTerminal):
+  def __init__(self):
+    super().__init__(verbose=True, debug=True, quiet=False)
+
+    mod = SubModule(Path("config.yml"), self)
+
+  def run(self):
+    pass
+
+# entry point
+if __name__ == "__main__":
+  app = Application()
+  app.run()
+```
+
 
 ## Contributors
 

pyTerminalUI/__init__.py

@@ -564,23 +564,27 @@ def BaseIndent(self, value):
 		self._baseIndent = value
 
 	_LOG_MESSAGE_FORMAT__ = {
-		Severity.Fatal:   "{DARK_RED}{message}{NOCOLOR}",
-		Severity.Error:   "{RED}{message}{NOCOLOR}",
+		Severity.Fatal:   "{DARK_RED}[FATAL] {message}{NOCOLOR}",
+		Severity.Error:   "{RED}[ERROR] {message}{NOCOLOR}",
 		Severity.Quiet:   "{WHITE}{message}{NOCOLOR}",
-		Severity.Warning: "{YELLOW}{message}{NOCOLOR}",
+		Severity.Warning: "{YELLOW}[WARNING]{message}{NOCOLOR}",
 		Severity.Info:    "{WHITE}{message}{NOCOLOR}",
-		Severity.DryRun:  "{DARK_CYAN}{message}{NOCOLOR}",
+		Severity.DryRun:  "{DARK_CYAN}[DRY] {message}{NOCOLOR}",
 		Severity.Normal:  "{WHITE}{message}{NOCOLOR}",
 		Severity.Verbose: "{GRAY}{message}{NOCOLOR}",
 		Severity.Debug:   "{DARK_GRAY}{message}{NOCOLOR}"
 	}                   #: Message formatting rules.
 
 	def ExitOnPreviousErrors(self):
+		"""Exit application if errors have been printed."""
+
 		if self._errorCounter > 0:
 			self.WriteFatal("Too many errors in previous steps.")
 			self.fatalExit()
 
 	def ExitOnPreviousWarnings(self):
+		"""Exit application if warnings have been printed."""
+
 		if self._warningCounter > 0:
 			self.WriteError("Too many warnings in previous steps.")
 			self.exit()

requirements.txt

@@ -1,2 +1,2 @@
-pyExceptions>=0.1.11
-pyMetaClasses>=1.0.0
+pyExceptions>=1.0.0
+pyMetaClasses>=1.1.0

setup.py

@@ -50,7 +50,7 @@
 
 setuptools.setup(
 	name=projectName,
-	version="1.3.2",
+	version="1.3.3",
 
 	author="Patrick Lehmann",
 	author_email="Paebbels@gmail.com",