From 8f71e7781e4032ce94e8b8e16768c00c71858b7a Mon Sep 17 00:00:00 2001 From: Lukas Winkler Date: Fri, 8 Sep 2017 18:57:20 +0200 Subject: [PATCH] improve README --- README.md | 36 +++++++++++++++++------------------- _locales/en/messages.json | 10 +--------- 2 files changed, 18 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index c412346..c5f58d7 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,26 @@ -customjs +Piwik Browser Injector ======== -[Custom JavaScript for websites - Chrome Extension](https://chrome.google.com/webstore/detail/custom-javascript-for-web/poakhlngfciodnhlhhgnaaelnpjljija) +[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/bglodhjbeeolbfpodfacccmnjledmggn.svg)](https://chrome.google.com/webstore/detail/piwik-injector/bglodhjbeeolbfpodfacccmnjledmggn) +[![Chrome Web Store](https://img.shields.io/badge/chrome%20web%20store-download%20now-brightgreen.svg)](https://chrome.google.com/webstore/detail/piwik-injector/bglodhjbeeolbfpodfacccmnjledmggn) -Run custom JavaScript on any website. -Use this tool to inject custom javascript in any website. + +Piwik Browser Injector helps you to try out [Piwik](https://piwik.org/), the leading open source web analytics software, in cases where it isn't possible to modify the source of a website or when you just want to quickly see how the visitor data of your website would look like in Piwik. -Your scripts are kept in the local storage and applied across domain URLs. +### Usage: +* open the domain, where you want to include the tracking code localy +* click on the Piwik Browser Injector icon in your toolbar and enter the URL to your piwik instance and the ID of your website +* if you want to try out advanced features you can enable the expert mode where you can freely modify the tracking code -You can use jQuery 1.11.0 or 2.1.0 or your own external scripts. +This extention is in an early development state and may include backward-incompatible changes in future versions. -Usage: -- site debugging (wrong list sort, etc.) -- hiding annoyng popups and Ads -- anything you can think of :) +If you notice any bugs or have wishes for features open an issue on the github repository: +https://github.com/Findus23/piwik-injector -New features: -- Ace Editor (formating, highlight, undo/redo by hotkeys) -- Draft auto save (so doesn't matter when you close the window without saving) -- Hosts (websites) switch (you can browse customjs of other websites) -- Include external script (eq. Underscore.js is cool) -![Mind map](http://hromadadan.com/customjs/mindmap.png) +Licended under [the MIT License](https://github.com/Findus23/piwik-injector/blob/master/LICENSE) and based on the work of [hromadadan](https://github.com/guzart/customjs) and [xcv58](https://github.com/xcv58/Custom-JavaScript-for-Websites-2) -Thanks to: -- Ace - http://ace.c9.io/ -- Pure - http://purecss.io/ \ No newline at end of file +![screenshot](docs/screenshot_chrome_1.png) \ No newline at end of file diff --git a/_locales/en/messages.json b/_locales/en/messages.json index 192190b..9ff10a9 100644 --- a/_locales/en/messages.json +++ b/_locales/en/messages.json @@ -1,20 +1,12 @@ { "extension_name": { - "message": "Piwik Injector", + "message": "Piwik Browser Injector", "description": "name of the extension" }, "extension_description": { "message": "Try out Piwik, the open source, privacy aware web analytics software, without the need to modify anything.", "description": "a short description shown in the extension list; should be pretty short, but descriptive" }, - "extension_firefox_description": { - "message": "piwik, analytics, javascript, debugging", - "description": "longer description text for firefox extension page; can use HTML to stucture the content" - }, - "extension_chrome_description": { - "message": "piwik, analytics, javascript, debugging", - "description": "longer description text for chrome extension page; can't use any formatting" - }, "extension_tags": { "message": "piwik, analytics, javascript, debugging, injecting, open source,", "description": "tags for Firefox addon description (maximum 20)"