chore: deprecate lib

BREAKING CHANGE: officially deprecate the lib
groupon · Oct 21, 2019 · 284a28d · 284a28d
1 parent f368148
commit 284a28d
Show file tree

Hide file tree

Showing 48 changed files with 10 additions and 1,946 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.gitignore b/.gitignore
diff --git a/.testiumrc b/.testiumrc
diff --git a/.travis.yml b/.travis.yml
diff --git a/API.md b/API.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -1,33 +1,14 @@
-# Testium [![travis-ci build](https://travis-ci.org/groupon/testium.svg?branch=master)](https://travis-ci.org/groupon/testium)
+[DEPRECATED] Please use a testing interface + a testium driver
 
-Testium is a testing library focused on providing a simple,
-but effective,
-tool for testing your web applications
-in different browsers (via Selenium)
-and headlessly (via PhantomJS).
+Test interface
+* [testium-mocha][testium-mocha]
 
-## Usage
+Testium drivers
 
-This particular module bundles a few different testium libraries together in a fashion
-that is no longer recommended.  Please instead use a testing interface modules + one
-of the testium drivers, e.g:
+* [testium-driver-sync][testium-driver-sync]
+* [testium-driver-wd][testium-driver-wd]
 
-https://github.com/testiumjs/testium-mocha and https://github.com/testiumjs/testium-driver-wd
-
-```
-$ npm install --save-dev testium-mocha testium-driver-wd
-```
-
-```javascript
-const { browser } = require('testium-mocha');
-
-describe('something', () => {
-  before(browser.beforeHook({ driver: 'wd' }));
-
-  it('works', () => browser.loadPage('/'));
-});
-```
-
-## API Docs
-
-For full API documentation, see the [Testium API Docs](http://testiumjs.com/api/)
+[testium-core]: https://github.com/testiumjs/testium-core
+[testium-mocha]: https://github.com/testiumjs/testium-mocha
+[testium-driver-wd]: https://github.com/testiumjs/testium-driver-wd
+[testium-driver-sync]: https://github.com/testiumjs/testium-driver-sync
diff --git a/cli.js b/cli.js