Merge remote-tracking branch 'template-base/master'

Author: DrewImm

.gitignore

@@ -47,6 +47,3 @@ dist/
 
 # Environment Variables
 .env
-
-# Docs build
-docs/

README.md

@@ -1,38 +1,5 @@
 # {{project-name}} - Readme
 
-## Development
+## Contributing & Development
 
-Run a dev test with `npm start`.
-
-## Running Tests
-
-To run unit tests, `npm run test`
-
-## Scripts
-
-You can write custom scripts in the `script/` directory. See `script/example.ts` as an example.
-
-Run your script with `npm run script -- example`
-
-## Compiling
-
-### Debug Builds
-
-To compile a debug build, run `npm run build`. The build output will appear in the `./dist` folder.
-
-### Prod Builds
-
-To compile a production build, run `npm run lint:prod && npm run build`. The build output will appear in the `./dist` folder.
-
-## More
-
-### Generating Docs
-
-`npm run doc` and browse docs/index.html!
-
-### Deploying to npm
-
-1. Did you bump your version?
-2. `npm run publish`
-
-You can test your build by running `npm run script -- pack`
+See [contributing.md](docs/contributing/contributing.md) for information on how to develop or contribute to this project!

docs/.gitignore

@@ -0,0 +1 @@
+typedoc/

docs/contributing/contributing.md

@@ -0,0 +1,5 @@
+# Contributing
+
+## Development Guide
+
+See the [development guide](development.md) for development documentation.

docs/contributing/development.md

@@ -0,0 +1,29 @@
+# Development
+
+Run a dev test with `npm start`.
+
+## Running Tests
+
+To run unit tests, `npm run test`
+
+## Scripts
+
+You can write custom scripts in the `script/` directory. See `script/example.ts` as an example.
+
+Run your script with `npm run script -- example`
+
+## Compiling
+
+### Debug Builds
+
+To compile a debug build, run `npm run build`. The build output will appear in the `./dist` folder.
+
+### Prod Builds
+
+To compile a production build, run `npm run lint:prod && npm run build`. The build output will appear in the `./dist` folder.
+
+## More
+
+### Generating Docs
+
+`npm run doc` and browse docs/index.html!

package.json

@@ -14,7 +14,7 @@
 		"test": "npm run lint && npm run build && nyc npm run test:run",
 		"test:run": "jasmine --config=jasmine.json",
 		"test:dev": "ts-node node_modules/jasmine/bin/jasmine --config=jasmine.dev.json",
-		"doc": "typedoc --out docs src",
+		"doc": "typedoc --out docs/typedoc src",
 		"format": "prettier-eslint --write **/*.*",
 		"lint": "eslint .",
 		"lint:prod": "npm run lint -- --config=.eslintrc.prod.json",