chore(): add readme file and clean up a little

Author: wbhob

packages/core/README.md

@@ -0,0 +1,38 @@
+# Orbital
+
+Orbital is the CLI framework from the future. Using powerful features from TypeScript, like metadata and decorators, there is no limit to what you can create with Orbital.
+
+## Features
+
+- Support for options and parameters (arguments)
+- Command and option aliases
+- Automatic help generation out of the box
+- Git-style subcommands
+
+## Example
+
+Here's an example of the simplest CLI you can build with Orbital.
+
+```ts
+import { CLI, Command, OrbitalFactory } from '@orbital/core';
+
+@Command({
+    name: 'hello'
+})
+export class HelloCommand {
+    execute() {
+        console.log('Hello, World!');
+    }
+}
+
+@CLI({
+    declarations: [
+        HelloCommand
+    ]
+})
+export class HelloCLI { }
+
+OrbitalFactory
+    .bootstrap(HelloCLI)
+    .execute(process.argv)
+```

packages/core/tsconfig-build.json

@@ -2,13 +2,16 @@
     "extends": "../../tsconfig.json",
     "compilerOptions": {
         "baseUrl": ".",
-        "outDir": "dist"
+        "outDir": "dist",
+        "sourceRoot": "src",
+        "sourceMap": true,
+        "declaration": true
     },
     "include": [
         "index.ts"
     ],
     "exclude": [
-        "test",
+        "src/test",
         "node_modules"
     ]
 }

tsconfig.json

@@ -4,7 +4,6 @@
     "target": "es6",
     "module": "commonjs",
     "baseUrl": ".",
-    "sourceRoot": "./src",
     "declaration": true,
     "outDir": "./dist",
     "experimentalDecorators": true,