doc: readme updates

adammy · Dec 30, 2021 · 6a88be2 · 6a88be2
1 parent fbe2a29
commit 6a88be2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,7 @@
-# Typescript Node Template
+# Typescript Node Template
+A starter template for a Node library built with Typescript.
+
+- *Base*: Uses Node 16 and TypeScript 4.5
+- *Testing*: [Mocha](https://mochajs.org/) as a test runner and [Chai](https://www.chaijs.com/) as the assertion library
+- *CI*: comes with a Github action for linting, running tests, and confirming a build can be created.
+- *Releases*: comes with a Github action for publishing to the NPM registry.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "typescript-node-template",
   "version": "1.0.0",
-  "description": "Starter template for a node library built with Typescript.",
+  "description": "Starter template for a Node library built with Typescript.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

diff --git a/src/cinema.test.ts → src/sample.test.ts b/src/cinema.test.ts → src/sample.test.ts