commit 8286109fa3c0578bfaf5e8c42b00008b99e6850f Author: z0ccc Date: Thu Jun 3 01:24:50 2021 -0400 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff030f5 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Chrome Extension boilerplate created with React Typescript + +## Getting started + +Create a project based on this boilerplate. + +``` +$ npx degit https://github.com/sivertschou/react-typescript-chrome-extension-boilerplate.git +``` + +Navigate to the project directory and install the dependencies. + +``` +$ npm install +``` + +To build the extension, and rebuild it when the files are changed, run + +``` +$ npm start +``` + +After the project has been built, a directory named `dist` has been created. You have to add this directory to your Chrome browser: + +1. Open Chrome. +2. Navigate to `chrome://extensions`. +3. Enable _Developer mode_. +4. Click _Load unpacked_. +5. Select the `dist` directory.