Merge pull request #40 from regal/0.x

Merge 0.3.0

.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2
+jobs:
+    build:
+        docker:
+            - image: circleci/node:10
+
+        working_directory: ~/regal
+
+        steps:
+            - checkout
+
+            # Download and cache dependencies
+            - restore_cache:
+                  keys:
+                      - v1-dependencies-{{ checksum "package.json" }}
+                      # fallback to using the latest cache if no exact match is found
+                      - v1-dependencies-
+
+            - run: npm install
+
+            - save_cache:
+                  paths:
+                      - node_modules
+                  key: v1-dependencies-{{ checksum "package.json" }}
+
+            - run:
+                name: Lint Check
+                command: npm run lint
+
+            # run tests!
+            - run: npm test
+
+            - run:
+                  name: Publish Test Coverage
+                  command: npm run publish-coverage
+
+            - run:
+                  name: Check Test Coverage
+                  command: npm run check-coverage

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            // Thanks https://medium.com/@benlesh/debugging-typescript-mocha-tests-with-vscode-89310051531
+            "type": "node",
+            "request": "launch",
+            "name": "Mocha All",
+            "program": "${workspaceFolder}\\node_modules\\mocha\\bin\\_mocha",
+            "args": [
+                "-r",
+                "ts-node/register",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}\\**\\*.test.ts"
+            ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "protocol": "inspector"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[typescript]": {
+        "editor.formatOnSave": true,
+    },
+    "tslint.autoFixOnSave": true
+}

CHANGELOG.md

@@ -2,10 +2,17 @@
 
 ## Pre-Initial Release
 
+### v0.3.0
+
+**First Testable Release**
+
+
 ### v0.2.1
+
 * Restructured declaration files
 * Added null-checking to `Event.runQueue`
 * Updated metadata
 
 ### v0.1.0
+
 * Initial Version

README.md

@@ -1,6 +1,8 @@
 # Regal
 
-*v0.2.1*
+[![npm version](https://badge.fury.io/js/regal.svg)](https://badge.fury.io/js/regal)
+[![CircleCI](https://circleci.com/gh/regal/regal.svg?style=svg)](https://circleci.com/gh/regal/regal)
+[![Coverage Status](https://coveralls.io/repos/github/regal/regal/badge.svg?branch=master)](https://coveralls.io/github/regal/regal?branch=master)
 
 ## Introduction
 
@@ -10,23 +12,11 @@ This library is a package on npm titled `regal`.
 
 ## Status
 
-This package is currently in version `0.2.1` and is not yet recommended for use. The next version will be `0.3.0`.
+Version `0.3.0` marks the first testable release of the library, but the package is still in early development.
 
-### `0.3.0` Details
+The upcoming version `0.4.0` will have significant changes. It's recommended that you don't use the library until the first stable version `1.0.0` is released.
 
-**Regal** `0.3.0` aims to be the first usable version of the library, and is currently under development.
-
-Component | Description | Designed | Implemented | Tested
---- | --- | --- | --- | ---
-**Game** | Public API for consumers of the library | ✔️ | ✔️ | ✔️
-**Agent** | Model for immutable game objects | ✔️ | ✔️ | ✔️
-**Event** | Model for game events | ✔️ | ✔️ | ✔️
-
-✔️ - Complete   
-🔵 - In-Progress    
-⚪- Planned
-
-## Contributors
+## Contributing
 
 Created by Joe Cowman ([jcowman2](https://github.com/jcowman2)).
 

docs/README.md

@@ -0,0 +1 @@
+<span style="color:red">**Warning: Due to the nature of early development, the documentation in this directory is outdated and should not be used as a reliable reference. It is only being kept in the repository for historical purposes until the next release.**</span>