df

commit 640ab2cc8521ec24ba902478236da72ae9ab59fe (HEAD -> master)
Author: vladislav.saifulin <vladislav.saifulin@jetbrains.com>
Date:   Sat Oct 5 02:55:47 2019 +0300

    first commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bdd5def
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+# chrome-extension-template
+
+## Introduction
+
+This project aims to provide an easy to use boilerplate for chrome extensions, showcasing communication between its different scripts.
+
+Not all extensions will need of all scripts or all types of messaging. All code snippets are optional. Text and images should be replaced with your own.
+
+## Installation
+
+Clone the repo:
+
+```
+git clone git@github.com:edrpls/chrome-extension-template.git name-of-your-project
+```
+
+Set git to track your own repository instead of this one:
+
+```
+git remote set-url --delete origin git@github.com:edrpls/chrome-extension-template.git # Remove old origin
+git remote set-url --add origin [YOUR REPO URL] # Add new origin
+```
+
+Install dependencies:
+
+```
+yarn install # or npm install
+```
+
+## Usage
+
+To run a development server that will watch for file changes and rebuild the scripts, run:
+
+```
+yarn start
+```
+
+To just build the files without the development server:
+
+```
+yarn build
+```
+
+Both commands will create a `dist/` directory, it will contain the built files that should be loaded into the browser or packed.
+
+## Load into Chrome
+
+To load the built files into Chrome, open [chrome://extensions/](chrome://extensions/).
+
+Enable "Developer mode" if it's not enabled yet:
+
+![Developer Mode Checkbox](assets/dev_mode.png)
+
+Click on "Load unpacked":
+
+![Load Unpacked Button](assets/load_unpacked.png)
+
+Find the `dist/` directory on your system and open it.
+
+The extension should be now at the top of the page:
+
+![Extension Loaded](assets/ext_loaded.png)
+
+## Publishing
+
+[Follow the official docs](https://developer.chrome.com/webstore/publish) to learn how to publish a Chrome extension.
+Please note that Google has its own process to review public extensions and using this boilerplate **does not guarantee** that the extension will pass it. Passing the review process is your responsibility!
+
+## External resources
+
+*   [Sample extension built with this template](https://github.com/edrpls/social-network-alert)
+
+*   [Chrome Developer Documentation](https://developer.chrome.com/extensions/devguide)
+
+*   [Overview slides about Chrome Extensions](https://github.com/edrpls/chrome-extensions-what-why-how)