Merge pull request #3 from typescript-template/issue-2

[Issue #2] Move development documentation out of readme

Author: DrewImm

.gitignore

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

README.md

@@ -1,31 +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!
+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

@@ -2,13 +2,13 @@
 	"name": "{{project-name}}",
 	"version": "1.0.0",
 	"typescript-template": {
-		"base": "1.0.0"
+		"base": "1.0.1"
 	},
 	"scripts": {
 		"build": "tsc",
 		"start": "ts-node src/index",
 		"test": "npm run lint",
-		"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",