From a62dd90535905bd066256714f3ec17bcf4f17c3d Mon Sep 17 00:00:00 2001 From: BraydonKains Date: Thu, 1 Jul 2021 22:35:08 -0400 Subject: [PATCH] README update --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 797c6a3..5586c7c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ -# js-test - -`js-test` will be a minimal JavaScript test runner. It will be able to run tests from the CLI or programatically. The aim of this library is to enable JavaScript developers to write test code in very plain JavaScript without needing to learn a whole testing framework. The test code written to be run by this package will look largely like plain JavaScript. The aim will be to enforce very little opinions on the developer. - -This project is still under development. I am still making some fundamental architecture decisions. The code in this repo will mostly be my scratch attempts at coming up with something usable. +# js-test + +`js-test` is a minimal JavaScript test runner. The aim of this library is to enable JavaScript developers to write test code in very plain JavaScript. To write test files with this language all one needs to do is: +1. Export functions whose names start with the word "test" +2. Name the file to match the format `*.test.{js,cjs,mjs}` +Then running `js-test` will run all the test files it can find in your project. + +Future plans: + +* Programmatic test running API, potentially separating that package from the CLI +* Support for custom test file patterns +* Prettier CLI output \ No newline at end of file