chore: update build process and instructions

cypress-io · Sep 26, 2019 · b34092e · b34092e
1 parent bd1c29e
commit b34092e
Show file tree

Hide file tree

Showing 5 changed files with 582 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -155,6 +155,14 @@ All components are in [src](src) folder. All tests are in [cypress/integration](
 
 ## Development
 
+To get started with this repo, compile the plugin's code and the examples code
+
+```shell
+npm run transpile
+npm run build
+npm run cy:open
+```
+
 - run TypeScript compiler in watch mode with `npx tsc -w`
 - run Cypress with `npx cypress open` and select the spec you want to work with
 - edit `lib/index.ts` where all the magic happens

diff --git a/cypress/support/index.js b/cypress/support/index.js
@@ -13,5 +13,7 @@
 // https://on.cypress.io/configuration
 // ***********************************************************
 
+// custom commands provided by this package, built from TypeScript code in "lib"
+// using "npm run transpile"
 import '../../dist'
 import '@percy/cypress'