Skip to content

docs: add build instructions to README#50

Open
kimjune01 wants to merge 1 commit into
vladlavrik:masterfrom
kimjune01:fix/build-documentation-31
Open

docs: add build instructions to README#50
kimjune01 wants to merge 1 commit into
vladlavrik:masterfrom
kimjune01:fix/build-documentation-31

Conversation

@kimjune01

Copy link
Copy Markdown

The README has no build instructions. Contributors have to reverse-engineer the build process from package.json scripts and CI config.

This adds a Development section covering prerequisites, build commands, Chrome extension loading, and common troubleshooting steps.

Fixes #31

Addresses vladlavrik#31 by adding comprehensive build documentation including:
- Prerequisites (Node.js 18+)
- Development and production build commands
- Instructions for loading unpacked extension in Chrome
- Troubleshooting for OpenSSL error

Fixes confusion from maintainer's comment which had typos
(npm build dev → npm run dev). Verified build output
directory is build/ not dist/.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

how to build this project

1 participant