From efc0ebba3170e0835cfe250ecfb2c52f4718b801 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Kiljan=CC=81czyk?= Date: Tue, 26 Mar 2024 18:26:09 +0100 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5a9a27e..bdf249b 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ # Chrome Extension (MV3) Boilerplate with React 18 and Vite 5 -[//]: # 'TODO: Publish the template on NPM' -[//]: # '[![npm](https://img.shields.io/npm/v/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)' -[//]: # '[![npm-download](https://img.shields.io/npm/dw/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)' -[//]: # '[![npm](https://img.shields.io/npm/dm/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)' +[//]: # (# 'TODO: Publish the template on NPM') + +[//]: # ([![npm](https://img.shields.io/npm/v/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)) + +[//]: # ([![npm-download](https://img.shields.io/npm/dw/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)) + +[//]: # ([![npm](https://img.shields.io/npm/dm/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)) This repository contains a boilerplate for building Chrome Extensions with React 18, TypeScript, and Vite 5. This boilerplate is inspired by and adapted @@ -16,17 +19,17 @@ from [chrome-extension-boilerplate-react](https://github.com/lxieyang/chrome-ext This is a basic Chrome Extensions boilerplate to help you write modular and modern Javascript code and load CSS easily. This boilerplate is using: -- [Chrome Extension Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/) -- [React 18](https://reactjs.org) -- [MUI](https://mui.com/) -- [CRXJS Vite Plugin](https://www.npmjs.com/package/@crxjs/vite-plugin/v/2.0.0-beta.23) -- ESLint: - - [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) - - [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier) - - [eslint-plugin-simple-import-sort](https://www.npmjs.com/package/eslint-plugin-simple-import-sort) - - [typescript-eslint](https://www.npmjs.com/package/typescript-eslint) -- [Prettier](https://prettier.io/) -- [TypeScript](https://www.typescriptlang.org/) +- [Chrome Extension Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/) +- [React 18](https://reactjs.org) +- [MUI](https://mui.com/) +- [CRXJS Vite Plugin](https://www.npmjs.com/package/@crxjs/vite-plugin/v/2.0.0-beta.23) +- ESLint: + - [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) + - [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier) + - [eslint-plugin-simple-import-sort](https://www.npmjs.com/package/eslint-plugin-simple-import-sort) + - [typescript-eslint](https://www.npmjs.com/package/typescript-eslint) +- [Prettier](https://prettier.io/) +- [TypeScript](https://www.typescriptlang.org/) Please open up an issue to nudge me to keep the npm packages up-to-date. @@ -77,7 +80,7 @@ at the [official guide](https://developer.chrome.com/webstore/publish) to more i ## Resources: -- [Chrome Extension documentation](https://developer.chrome.com/extensions/getstarted) +- [Chrome Extension documentation](https://developer.chrome.com/extensions/getstarted) ---