initial readme commit

atk4 · Dec 14, 2018 · 5653c2a · 5653c2a
commit 5653c2a
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+## Agile Toolkit Extension for Chrome.
+
+Help debuging javascript when using Agile Toolkit framework.
+
+### Callback debug
+
+The ATK develppper panel will properly formatted json response into readable code in order
+to help debugging javascript action return by server.
+
+<p align="center"><img width="720px" src="https://raw.githubusercontent.com/atk4/atk-chrome/master/media/atk-panel.png" alt="screenshot"></p>
+
+### Plugin property content
+
+This is a sidebar panel available when using the Element panel in Chrome. 
+It will display jQuery data property of a selected element.
+
+<p align="center"><img width="720px" src="https://raw.githubusercontent.com/atk4/atk-chrome/master/media/atk-plugin-properties.png" alt="screenshot"></p>
+
+
+### Manual Installation
+
+**Make sure you are using Node 6+ and NPM 3+**
+
+1. Clone this repo
+2. Open Chrome extension page
+3. Check "developer mode"
+4. Click "load unpacked extension", and choose `atkjs-chrome`.
+
+
+
+### License
+
+[MIT](http://opensource.org/licenses/MIT)
diff --git a/media/atk-panel.png b/media/atk-panel.png
diff --git a/media/atk-plugin-properties.png b/media/atk-plugin-properties.png