docs: refresh README (#893)

* chore: rename repository links

* docs: replace hermione-instances to tesplane in README file

CONTRIBUTING.md

@@ -3,14 +3,14 @@
 * Tests must pass.
 * Follow our coding style (eslint will help you).
 * If you fix a bug, add a test.
-* If you can't fix a bug, file an [issue](https://github.com/gemini-testing/hermione/issues) with the steps to reproduce, the expected and the actual results.
+* If you can't fix a bug, file an [issue](https://github.com/gemini-testing/testplane/issues) with the steps to reproduce, the expected and the actual results.
 * if an issue desribes a problem which we are unable to reproduce and issue reporter does not answer our questions for 1 week, then this issue may be closed without further investigation.
 
 ## How to develop
 ### Create your own copy
 ```
-git clone https://github.com/gemini-testing/hermione.git
-cd hermione
+git clone https://github.com/gemini-testing/testplane.git
+cd testplane
 npm install
 ```
 

package.json

@@ -27,20 +27,21 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/gemini-testing/hermione.git"
+    "url": "git://github.com/gemini-testing/testplane.git"
   },
   "engines": {
     "node": ">= 18.0.0"
   },
   "keywords": [
+    "testplane",
     "hermione",
     "webdriverio",
     "mocha",
     "test"
   ],
   "bin": {
-    "hermione": "./bin/hermione",
-    "testplane": "./bin/testplane"
+    "testplane": "./bin/testplane",
+    "hermione": "./bin/hermione"
   },
   "license": "MIT",
   "dependencies": {

src/browser/commands/types.ts

@@ -3,7 +3,7 @@ import { AssertViewOptsConfig } from "../../config/types";
 export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
     /**
      * Maximum allowed difference between colors.
-     * Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#tolerance tolerance} value.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#tolerance tolerance} value.
      *
      * @remarks
      * Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode.
@@ -15,7 +15,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
     tolerance?: number;
     /**
      * Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels.
-     * Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#antialiasingTolerance antialiasingTolerance} value.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#antialiasingTolerance antialiasingTolerance} value.
      *
      * @remarks
      * Read more about this option in {@link https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing looks-same}
@@ -25,7 +25,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
     antialiasingTolerance?: number;
     /**
      * Allows testing of regions which bottom bounds are outside of a viewport height.
-     * Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#compositeImage compositeImage} value.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#compositeImage compositeImage} value.
      *
      * @remarks
      * In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height.
@@ -35,7 +35,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
     compositeImage?: boolean;
     /**
      * Allows to specify a delay (in milliseconds) before making any screenshot.
-     * Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#screenshotDelay screenshotDelay} value.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#screenshotDelay screenshotDelay} value.
      *
      * @remarks
      * This is useful when the page has elements which are animated or if you do not want to screen a scrollbar.

src/browser/types.ts

@@ -70,7 +70,7 @@ declare global {
              * Takes a screenshot of the passed selector and compares the received screenshot with the reference.
              *
              * @remarks
-             * For more details, see {@link https://github.com/gemini-testing/hermione#assertview documentation}.
+             * For more details, see {@link https://github.com/gemini-testing/testplane#assertview documentation}.
              *
              * @example
              * ```ts
@@ -102,7 +102,7 @@ declare global {
              * Command that allows to add human-readable description for commands in history
              *
              * @remarks
-             * For more details, see {@link https://github.com/gemini-testing/hermione#runstep documentation}
+             * For more details, see {@link https://github.com/gemini-testing/testplane#runstep documentation}
              *
              * @example
              * ```ts
@@ -143,7 +143,7 @@ declare global {
              * Takes a screenshot of the element and compares the received screenshot with the reference.
              *
              * @remarks
-             * For more details, see {@link https://github.com/gemini-testing/hermione#assertview documentation}.
+             * For more details, see {@link https://github.com/gemini-testing/testplane#assertview documentation}.
              *
              * @example
              * ```ts

src/config/types.ts

@@ -35,8 +35,8 @@ export interface AssertViewOptsConfig {
      * @remarks
      * By default Hermione throws an error if element is outside the viewport bounds.
      * This option disables check that element is outside of the viewport left, top, right or bottom bounds.
-     * And in this case if browser option {@link https://github.com/gemini-testing/hermione#compositeimage compositeImage} set to `false`, then only visible part of the element will be captured.
-     * But if {@link https://github.com/gemini-testing/hermione#compositeimage compositeImage} set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport.
+     * And in this case if browser option {@link https://github.com/gemini-testing/testplane#compositeimage compositeImage} set to `false`, then only visible part of the element will be captured.
+     * But if {@link https://github.com/gemini-testing/testplane#compositeimage compositeImage} set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport.
      *
      * @defaultValue `false`
      */