add interactive helper menu

Author: yooper

composer.json

@@ -13,7 +13,7 @@
         "psr-4": {
             "TextAnalysis\\": "src/"
 	},
-        "files": ["src/helpers/storage.php", "src/helpers/print.php", "src/helpers/simplified.php", "src/helpers/helpers.php"]
+        "files": ["src/helpers/storage.php", "src/helpers/print.php", "src/helpers/simplified.php", "src/helpers/helpers.php", "src/helpers/interactive_help.php"]
     },
     "autoload-dev": {
         "files": ["tests/TestBaseCase.php"]

interactive

@@ -1,4 +1,6 @@
-#!/usr/bin/bash
+#!/bin/bash
 # run the library in an interactive mode for doing analysis
+echo "Welcome to the PHP Text Analysis Interactive Console"
+echo "Type help(); to get a list of available functions"
 php -a -d auto_prepend_file=./vendor/autoload.php
 

src/helpers/interactive_help.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * List out a help menu in the interactive console
+ */
+function help()
+{
+    $menu = [
+        'text(string $text) -> Return a TextCorpus object',
+        'normalize(string $text) -> Normalize text to lower case',
+        'todo ....'
+    ];
+    print_array($menu);
+}
+