add README

Author: delabiejochen

.publishrc

@@ -0,0 +1,15 @@
+{
+  "validations": {
+    "vulnerableDependencies": true,
+    "uncommittedChanges": true,
+    "untrackedFiles": true,
+    "sensitiveData": true,
+    "branch": false,
+    "gitTag": true
+  },
+  "confirm": true,
+  "publishCommand": "npm publish",
+  "publishTag": "latest",
+  "prePublishScript": "npm make",
+  "postPublishScript": false
+}

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 TestingBot, released under MIT License.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,60 @@
-## This will soon host the Cypress CLI for running tests on TestingBot
+# TestingBot Cypress CLI
+[![npm version](https://badge.fury.io/js/testingbot-cypress-cli.svg)](https://badge.fury.io/js/testingbot-cypress-cli)
+
+The `testingbot-cypress-cli` is command-line interface (CLI) which
+allows you to run Cypress tests on TestingBot. TestingBot provides a 
+large grid of browsers and devices to run both manual and automated tests.
+
+-   [Quick Start](#quick-start)
+-   [Documentation](#documentation)
+-   [Getting Help](#getting-help)
+-   [License](#license)
+
+## Quick Start
+To get started, simply install the CLI and configure it to use your Cypress project:
+
+### Install the CLI
+
+You can easily install the CLI via `npm` or `yarn`:
+
+```bash
+$ npm install -g testinbot-cypress-cli
+```
+
+### Configure
+
+Once the CLI is installed, you'll need to point it to a configuration file.
+The configuration file will point the CLI to the Cypress project and will supply
+the TestingBot credentials.
+
+To set up a new configuration file (`testingbot.json`), simply run this command:
+
+```bash
+$ testingbot-cypress init
+```
+
+This will create a `testingbot.json` file. Please add the `key` and `secret` you obtained from the TestingBot member dashboard in this file.
+
+Next, please supply `cypress_proj_dir` with is the path to the folder that contains the `cypress.json` file.
+As an example, you can use the [Cypress Kitchen Sink Example](https://github.com/cypress-io/cypress-example-kitchensink).
+
+### Run tests
+
+Now you're ready to start running your Cypress tests on TestingBot.
+To start the tests, please run:
+```bash
+$ testingbot-cypress run
+```
+
+Once you've started this command, the tests will start to appear in the [TestingBot Dashboard](https://testingbot.com/members).
+
+## Documentation
+
+## Getting Help
+
+If you need help, please reach out to us via [email protected] or our public Slack: https://testingbot.com/support
+
+## License
+
+This project is released under MIT License. Please see the
+[LICENSE.md](LICENSE.md) for more details.