From 6a88be2853bd35106bd36e32ce00e5ea43558940 Mon Sep 17 00:00:00 2001 From: Adam MacDonald Date: Thu, 30 Dec 2021 13:56:18 -0600 Subject: [PATCH] doc: readme updates --- README.md | 8 +++++++- package.json | 2 +- src/{cinema.test.ts => sample.test.ts} | 0 3 files changed, 8 insertions(+), 2 deletions(-) rename src/{cinema.test.ts => sample.test.ts} (100%) diff --git a/README.md b/README.md index b851f28..4a24baf 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# Typescript Node Template \ No newline at end of file +# 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 index 37af80a..a9ef934 100644 --- 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 b/src/sample.test.ts similarity index 100% rename from src/cinema.test.ts rename to src/sample.test.ts