diff --git a/.husky/pre-commit b/.husky/pre-commit index 5ee7abd..1387987 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1 +1,4 @@ +if command -v fnm >/dev/null 2>&1; then + eval "$(fnm env)" +fi pnpm exec lint-staged diff --git a/README.md b/README.md index c876266..c4dba3b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # Azon Seeker -This browser extension is used to collect goods' information in amazon. + +## Introduction + +This browser extension is used to collect goods' information on Amazon. + +## Setup + +### 1. Prepare Requirements + +Make sure the following software is installed: + +- node.js +- pnpm + +### 2. Clone this Repo + +```shell +git clone https://github.com/primedigitaltech/azon_seeker.git +``` + +### 3. Install the Node Dependencies + +```shell +cd {path to repo} +pnpm i +``` + +### 4. Run in Development Mode + +```shell +pnpm dev +``` + +### 5. Load Extension on Browser + +Open the browser extension page. +Toggle on development mode. +Load the extension using the `extension/` folder.