diff --git a/README.md b/README.md index aee4d3d..1bc1696 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,19 @@ -# Rooibos sample test project. - -Rooibos currently requires brighterscript version 0.52.3 - please use only this version. We are working to resolve this issue, so it works with current versions of brighterscript and will have a solution for this limitation, shortly. - -Clone this project so you can start playing with rooibos 4 right now. It demonstrates: - - - project setup with the brighterscript compiler - - folder structure - - launch tasks - - npm scripts - - plugins - - integration with roobios - - installation - - bsconfig configuration - - custom test suite - - basic test usage - - beforeEach - - beforeEach for a specific group - - mocking +# Rooibos sample test project +This is a sample test project using the [Rooibos testing framework for Roku](https://github.com/georgejecook/rooibos) +Clone this project so you can start playing with Rooibos right away. It demonstrates: +- Project setup with the brighterscript compiler + - Folder structure + - Launch tasks + - NPM scripts + - Plugins +- Integration with Rooibos + - Installation + - Bsconfig configuration + - Custom test suite +- Basic test usage + - `beforeEach` + - `beforeEach` for a specific group + - Mocking diff --git a/package.json b/package.json index c497b35..4a871b2 100644 --- a/package.json +++ b/package.json @@ -1,20 +1,29 @@ { "name": "rooibos-sample", "version": "1.0.0", - "description": "", - "main": "index.js", + "description": "Sample application demonstrating how to use the Rooibos testing framework for Roku.", "author": "", "license": "ISC", "devDependencies": { "brighterscript": "0.52.3", - "rooibos-roku": "5.2.3", + "rooibos-roku": "5.4.2", "undent": "0.1.0", - "roku-deploy": "3.7.0", - "roku-log-bsc-plugin": "0.6.1", + "roku-deploy": "3.10.0", + "roku-log-bsc-plugin": "0.7.0", "bslib": "1.0.0" }, "scripts": { "build-tests": "npx bsc", "build-tdd": "npx bsc --project bsconfig-tdd.json" - } + }, + "repository": { + "type": "git", + "url": "https://github.com/georgejecook/rooibos-roku-sample.git" + }, + "keywords": [ + "rooibos", + "roku", + "testing" + ], + "homepage": "https://github.com/georgejecook/rooibos-roku-sample" }