diff --git a/packages/cli/README.md b/packages/cli/README.md index 6c60dbce5..6f9324f60 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -19,25 +19,26 @@ $ npm install --save-dev @percy/cli ## Command Topics -- [`percy exec`](./packages/cli-exec#readme) - capture and upload snapshots -- [`percy snapshot`](./packages/cli-snapshot#readme) - snapshot a static directory or a list of pages -- [`percy upload`](./packages/cli-upload#readme) - upload a static directory of images -- [`percy config`](./packages/cli-config#readme) - manage configuration files -- [`percy build`](./packages/cli-build#readme) - interact with Percy builds +- [`percy exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#readme) - capture and upload snapshots +- [`percy snapshot`](https://github.com/percy/cli/tree/master/packages/cli-snapshot#readme) - snapshot a static directory or a list of pages +- [`percy upload`](https://github.com/percy/cli/tree/master/packages/cli-upload#readme) - upload a static directory of images +- [`percy config`](https://github.com/percy/cli/tree/master/packages/cli-config#readme) - manage configuration files +- [`percy build`](https://github.com/percy/cli/tree/master/packages/cli-build#readme) - interact with Percy builds +- [`@percy/cli-app`](https://github.com/percy/cli/tree/master/packages/cli-app#readme) - Percy CLI commands for running Percy with native apps. ### Advanced In addition to the CLI packages, this repo contains core libraries responsible for Percy's CI/CD integrations, Percy API communication, DOM serialization, asset discovery, etc. -- [`@percy/core`](./packages/core#readme) - performs snapshot asset discovery and uploading -- [`@percy/client`](./packages/client#readme) - handles communicating with the Percy API -- [`@percy/dom`](./packages/dom#readme) - serializes DOM snapshots -- [`@percy/env`](./packages/env#readme) - captures CI build environment variables -- [`@percy/config`](./packages/config#readme) - loads Percy configuration files -- [`@percy/logger`](./packages/logger#readme) - common logger used throughout the CLI -- [`@percy/sdk-utils`](./packages/sdk-utils#readme) - shared helpers for JavaScript SDKs -- [`@percy/cli-command`](./packages/cli-command#readme) - Percy CLI command framework +- [`@percy/core`](https://github.com/percy/cli/tree/master/packages/core#readme) - performs snapshot asset discovery and uploading +- [`@percy/client`](https://github.com/percy/cli/tree/master/packages/client#readme) - handles communicating with the Percy API +- [`@percy/dom`](https://github.com/percy/cli/tree/master/packages/dom#readme) - serializes DOM snapshots +- [`@percy/env`](https://github.com/percy/cli/tree/master/packages/env#readme) - captures CI build environment variables +- [`@percy/config`](https://github.com/percy/cli/tree/master/packages/config#readme) - loads Percy configuration files +- [`@percy/logger`](https://github.com/percy/cli/tree/master/packages/logger#readme) - common logger used throughout the CLI +- [`@percy/sdk-utils`](https://github.com/percy/cli/tree/master/packages/sdk-utils#readme) - shared helpers for JavaScript SDKs +- [`@percy/cli-command`](https://github.com/percy/cli/tree/master/packages/cli-command#readme) - Percy CLI command framework ## Issues @@ -50,7 +51,7 @@ request](https://www.browserstack.com/contact?ref=percy#technical-support). ## Developing This project is built with [lerna](https://lerna.js.org/). The core libaries and CLI plugins are -located in [./packages](./packages). Run `yarn` to install dependencies after cloning the repo and +located in [./packages](https://github.com/percy/cli/tree/master/packages). Run `yarn` to install dependencies after cloning the repo and use the following scripts for various development tasks: - `yarn build` - build all packages