Update readme

Add .sketchplugin to repo
wousser · Jun 21, 2019 · fd92332 · fd92332
1 parent 06e2060
commit fd92332
Show file tree

Hide file tree

Showing 12 changed files with 87 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 # build artifacts
-excelContentSync.sketchplugin
+#excelContentSync.sketchplugin
 
 # npm
 node_modules

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Decouple and Sync multi-language content between Sketch and Excel.
 
-![](ScreenRecording.gif)
+![ScreenRecording](ScreenRecording.gif)
 
 ## Use cases
 - Decouple your content from Sketch so you can hand-off your content for review by a copy-writer
@@ -13,11 +13,15 @@ Decouple and Sync multi-language content between Sketch and Excel.
 
 - Backup your Sketch file (just in case)
 - Prefix your text layers and/or symbol layers that you want to include with '#'
-- Generate Excel file with all your content: Plugins -> Excel Translate -> Generate Content File...
-- Select the Content File: Plugins -> Excel Translate -> Select Content File...
+- Generate Excel file with all your content: Plugins -> Excel Content Sync -> Generate Content File...
+- Select the Content File: Plugins -> Excel Content Sync -> Select Content File...
 - Select your language
 - Wait till your Sketch file is updated.
 
+## Installation
+1. [Download the Zip](https://github.com/wousser/SketchExcelContentSync/archive/master.zip) and unzip the package
+2. Double click on `excelContentSync.sketchplugin` for auto installation
+
 ## How many language are supported
 - As many as you want. Each columnn in your Excel file can be chosen as a language source.
 

diff --git a/....sketchplugin/Contents/Resources/_webpack_resources/957505d8b0d75728fc525a0146754d5f.html b/....sketchplugin/Contents/Resources/_webpack_resources/957505d8b0d75728fc525a0146754d5f.html
@@ -0,0 +1,6 @@
+<html>
+    <body>
+        <h1>hello</h1>
+        <p>world</p>
+    </body>
+</html>
diff --git a/excelContentSync.sketchplugin/Contents/Resources/html/test.html b/excelContentSync.sketchplugin/Contents/Resources/html/test.html
@@ -0,0 +1,6 @@
+<html>
+    <body>
+        <h1>hello</h1>
+        <p>world</p>
+    </body>
+</html>
diff --git a/excelContentSync.sketchplugin/Contents/Resources/icon.png b/excelContentSync.sketchplugin/Contents/Resources/icon.png
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/generate-content-file.js b/excelContentSync.sketchplugin/Contents/Sketch/generate-content-file.js
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/generate-content-file.js.map b/excelContentSync.sketchplugin/Contents/Sketch/generate-content-file.js.map
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/manifest.json b/excelContentSync.sketchplugin/Contents/Sketch/manifest.json
@@ -0,0 +1,61 @@
+{
+  "name": "Excel Content Sync",
+  "description": "Decouple and Sync multi-language content between Excel and Sketch",
+  "author": "Wouter Bron",
+  "homepage": "https://github.com/wousser/SketchExcelContentSync",
+  "compatibleVersion": 3,
+  "bundleVersion": 1,
+  "icon": "icon.png",
+  "commands": [
+    {
+      "name": "Select Content File...",
+      "description": "Select the Excel or CSV file that contains the content.",
+      "identifier": "select-content-file",
+      "script": "sync-page.js",
+      "handler": "selectContentFile"
+    },
+    {
+      "name": "Sync Current Page...",
+      "description": "Sync content from Excel file to this page.",
+      "identifier": "sync-current-page",
+      "script": "sync-page.js",
+      "handler": "syncCurrentPage"
+    },
+    {
+      "name": "Sync All Pages...",
+      "description": "Sync content from Excel file to all pages (except Symbols).",
+      "identifier": "sync-all-pages",
+      "script": "sync-page.js",
+      "handler": "syncAllPages"
+    },
+    {
+      "name": "Generate Content File...",
+      "description": "Generate Excel file with keys and values from the current Sketch document.",
+      "identifier": "generate-content-file",
+      "script": "generate-content-file.js"
+    },
+    {
+      "name": "Report Issue or Feedback",
+      "description": "Report Issue, Feedback or Feature on Github.",
+      "identifier": "open-feedback",
+      "script": "open-url.js",
+      "handler": "openFeedback"
+    }
+  ],
+  "menu": {
+    "title": "Excel Content Sync",
+    "items": [
+      "sync-current-page",
+      "sync-all-pages",
+      "-",
+      "select-content-file",
+      "generate-content-file",
+      "-",
+      "open-feedback"
+    ]
+  },
+  "version": "0.1.1-3",
+  "identifier": "Excel Content Sync",
+  "disableCocoaScriptPreprocessor": true,
+  "appcast": "https://raw.githubusercontent.com/wousser/SketchExcelContentSync/master/.appcast.xml"
+}
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/open-url.js b/excelContentSync.sketchplugin/Contents/Sketch/open-url.js
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/open-url.js.map b/excelContentSync.sketchplugin/Contents/Sketch/open-url.js.map
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/sync-page.js b/excelContentSync.sketchplugin/Contents/Sketch/sync-page.js
diff --git a/excelContentSync.sketchplugin/Contents/Sketch/sync-page.js.map b/excelContentSync.sketchplugin/Contents/Sketch/sync-page.js.map