Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs #131

Merged
merged 2 commits into from
May 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .travis.yml

This file was deleted.

18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,27 @@ Simple, mocha-and junit inspired, flexible, fun Brightscript test framework for

[![Build Status](https://travis-ci.org/georgejecook/rooibos.svg?branch=master)](https://travis-ci.org/georgejecook/rooibos)
[![GitHub](https://img.shields.io/github/release/georgejecook/rooibos.svg?style=flat-square)](https://github.com/georgejecook/rooibos/releases)
[![NPM Version](https://badge.fury.io/js/rooibos-roku.svg?style=flat)](https://npmjs.org/package/rooibos-roku)

## Links
- **[Documentation](docs/index.md)**
- **[API Documentaiton](https://georgejecook.github.io/rooibos)**
- **[API Documentation](https://georgejecook.github.io/rooibos)**
- **[CHANGELOG](CHANGELOG.md)**
- **[VSCode snippets](docs/vsCodeSnippets.md)**
- [Roku dev forum topic](https://forums.roku.com/viewforum.php?f=34)
- \#roku channel on the [roku developer's slack](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzgyODg0ODY0NDM5LTc2ZDdhZWI2MDBmYjcwYTk5MmE1MTYwMTA2NGVjZmJiNWM4ZWY2MjY1MDY0MmViNmQ1ZWRmMWUzYTVhNzJiY2M)
- [Issue tracker](https://github.com/georgejecook/rooibos/issues)
- [Roadmap](ROADMAP.md)

## Development

Rooibos is an independent open-source project, maintained exclusively by volunteers.

You might want to help! Get in touch via the slack group, or raise issues.

## Thanks

Rooibos was hacked together from the official roku unit testing framework. I'd like to say a big thank you to the guys at roku who gave me permission to build upon their work. The original framework can be found here : [https://github.com/rokudev/unit-testing-framework](https://github.com/rokudev/unit-testing-framework)

Also thanks to the guys who made and maintain [mochaJs](https://mochajs.org/), on which many of my changes are based upon, as well as the structure of the documentation.

## FAQ
### Is Rooibos ready for production use?

Yes, it's been used in production by quite a few folks, I'll provide a list in due-course; but there are 1000's of tests in production in some very respectable companies.
Yes, it's been used in production by quite a few folks, I'll provide a list in due-course; but there are 10'000's of tests in production in some very respectable companies.


### Is Rooibos actively maintained?

I love rooibos, and always keep it up to date. I use it all the time.

### Why 4.0.0?

Rooibos now uses the excellent bsc compiler plugin mechanism to seamlessly integrate with the compiler and the vscode IDE extension. This is a breaking change - projects will require updates to work.
7 changes: 0 additions & 7 deletions bsc-plugin/.travis.yml

This file was deleted.

34 changes: 9 additions & 25 deletions bsc-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
<p align="center">
<img src="images/logo.png" alt="Plugin for using maestro with vscode ide" width="200" height="200"/>
</p>
<h3 align="center">
VSCode ide plugin for [maestro](https://github.com/georgejecook/maestro) projects
VSCode ide plugin for [rooibos](https://github.com/georgejecook/rooibos)
</h3>

[![Build Status](https://travis-ci.org/georgejecook/maestro-vsc-extension-plugin.svg?branch=master)](https://travis-ci.org/georgejecook/maestro-vsc-extension-plugin)
[![codecov](https://codecov.io/gh/georgejecook/maestro-vsc-extension-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/georgejecook/maestro-vsc-extension-plugin)
[![GitHub](https://img.shields.io/github/release/georgejecook/maestro-vsc-extension-plugin.svg?style=flat-square)](https://github.com/georgejecook/maestro-vsc-extension-plugin/releases)
[![NPM](https://nodei.co/npmmaestro-vsc-extension-plugin.png)](https://npmjs.org/packagemaestro-vsc-extension-plugin)
[![Build Status](https://travis-ci.org/georgejecook/rooibos.svg?branch=master)](https://travis-ci.org/georgejecook/rooibos)
[![GitHub](https://img.shields.io/github/release/georgejecook/rooibos.svg?style=flat-square)](https://github.com/georgejecook/rooibos/releases)
[![NPM Version](https://badge.fury.io/js/rooibos-roku.svg?style=flat)](https://npmjs.org/package/rooibos-roku)

## Links
- [maestro](https://github.com/georgejecook/maestro)
- [Issue tracker](https://github.com/georgejecook/maestro-vsc-extension-plugin/issues)
- [CHANGELOG](CHANGELOG.md)

# About

This repo contains the source for `maestro-vsc-extension-plugin`, which is used by the - [maestro framework](https://github.com/georgejecook/maestro).

Use this plugin with vscode to use advanced features of maestro such as:

- XML binding support
- Reflection
- Dynamic imports

## Get help

Read how to use these features and the maestro framework [here](https://github.com/georgejecook/maestro:
- **[Documentation](docs/index.md)**
- **[API Documentation](https://georgejecook.github.io/rooibos)**
- **[CHANGELOG](CHANGELOG.md)**
- **[VSCode snippets](docs/vsCodeSnippets.md)**
- \#roku channel on the [roku developer's slack](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzgyODg0ODY0NDM5LTc2ZDdhZWI2MDBmYjcwYTk5MmE1MTYwMTA2NGVjZmJiNWM4ZWY2MjY1MDY0MmViNmQ1ZWRmMWUzYTVhNzJiY2M)