Merge branch 'dev'

Author: MCStreetguy

CHANGELOG.md

@@ -12,7 +12,7 @@
   - .MD ~ Markdown file `unimportable`
 #### Improvements
 - Quick Start Guide enhanced
-- `README.md`
+- `README.md` / `HOWTO.md`
 - IMEX module configuration
 - Auto-set Editor grammar when inserting into new file
 #### Patches

HOWTO.md

@@ -2,7 +2,8 @@
 
 ---
 
-## Examples
+## Using the snippet-injector
+
 ### Create
 (_[Reference](README.md#commands)_)
 
@@ -58,3 +59,33 @@ The snippet is now deleted from the local Atom storage.
 
 
 ---
+
+## Using the IMEX module
+
+The IMEX (shorthand for 'IMport and EXport') module provides import and export
+functionalities. It ships with several format configurations and parsing methods.
+To access it, open the `Packages` menu and navigate down to the submenu
+`Snippet Injector`. There you should find the options `Import Snippets` and
+`Export Snippets` (which is a submenu).
+
+### Exporting
+(_[Reference](README.md#commands)_)
+
+To export your snippets, open the named submenu `Export Snippets` and
+select a format of your choise. (All available formatting options can be found [here](README.md#snippet-injectorexport-to-)).
+Afterwards you will be prompted for a saving location and the file will be stored there.
+
+### Importing
+(_[Reference](README.md#commands)_)
+
+To import previously exported data, select the `Import Snippets` option in the menu.
+You will be prompted for a file to import from. The format is recognized automatically,
+the file contents get parsed accordingly and are stored as new snippets.
+
+
+### Please notice!
+If you want to import data back later on, make sure you choose a format
+that is stated as "importable" and **_not for a moment_ touch the file contents!**
+The IMEX module does not recognize invalid data and will parse everything within
+the given file. This may result in Fatal Errors or broken snippets.
+> *Don't complain later, I told you so...*

README.md

@@ -1,24 +1,25 @@
 # Atom Snippet Injector
 **An easy but powerful snippet management tool for Atom editor.**
+
 This atom package provides a JSON based snippet management.
 
 *But why use this package* you ask?
 
 Because you can reach every feature in more or less three steps.
 
 It's easy and fast so you don't have to struggle with difficult UI's or file syntaxes or even worse, writing the snippets manually.
-Check out the [Quick Start Guide](HOWTO.md#examples) for more instructions on how to use this package.
+Check out the [Quick Start Guide](HOWTO.md#using-the-snippet-injector) for short instructions on how to use this package.
 Happy Coding :)
 
 ---
 
 ## Reference
 
-#### Commands
+### Commands
 The following commands are registered by Snippet Injector and can be accessed via the command palette.
 If stated, the commands can also be called through menus or via hotkey.
 
-##### **snippet-injector:create**
+#### **snippet-injector:create**
 This command creates a new snippet from the current selection in the current editor.
 You will be prompted for a snippet title.
 
@@ -30,7 +31,7 @@ You will be prompted for a snippet title.
 
 ---
 
-##### **snippet-injector:update**
+#### **snippet-injector:update**
 This command updates an existing snippet's content to the current selection in the current editor.
 You will be prompted for choosing an existing snippet.
 
@@ -39,7 +40,7 @@ You will be prompted for choosing an existing snippet.
 
 ---
 
-##### **snippet-injector:insert**
+#### **snippet-injector:insert**
 This command injects a snippet to the current marker position(s).
 You will be prompted to choose a snippet from a list.
 
@@ -51,7 +52,7 @@ You will be prompted to choose a snippet from a list.
 
 ---
 
-##### **snippet-injector:delete**
+#### **snippet-injector:delete**
 This command deletes a snippet from the local storage.
 You will be prompted for the snippet name to delete.
 
@@ -60,12 +61,44 @@ You will be prompted for the snippet name to delete.
 
 ---
 
-##### **snippet-injector:toggledebug**
+#### **snippet-injector:toggledebug**
 This command toggles all debugging options for the package.
 Debug informations are logged in Atom's console.
 
 *Please notice that this command is just available through command palette!*
 
+---
+
+#### **snippet-injector:import**
+This command imports previously exported data from an importable file format.
+The format is recognized automatically, the contained data gets parsed
+and the resulting snippets will be stored simultaneously.
+
+Since this command is part of the [IMEX module](HOWTO.md#using-the-imex-module), I recommend usage via main menu.
+
+*Name in menus:*
+> "Import Snippets"
+
+---
+
+#### **snippet-injector:export-to-...**
+This command exports the local storage in the given file format.
+All snippets get parsed, based on the specific configuration and then are written into a user chosen file.
+
+Since this command is part of the [IMEX module](HOWTO.md#using-the-imex-module), I recommend usage via main menu.
+
+###### available formats:
+
+| Format   | Extension | Command                        | Importable | additional Infos                           |
+|---------:|-----------|--------------------------------|:----------:|--------------------------------------------|
+| CSV      | .csv      | snippet-injector:export-to-csv | yes        | Files may look untidy, use it as recovery  |
+| Markdown | .md       | snippet-injector:export-to-md  | no         | Human-readable, beautified                 |
+
+*Name in menus:*
+> "Export Snippets  ->  ..."
+
+
+---
 
 ---
 

package.json

@@ -3,7 +3,13 @@
   "main": "./lib/snippet-injector",
   "version": "1.2.6",
   "description": "An easy but powerful snippet management tool for Atom editor.",
-  "keywords": [],
+  "keywords": [
+    "snippets",
+    "snippet-injector",
+    "snippet-manager",
+    "atom",
+    "atom-editor"
+  ],
   "repository": "https://github.com/MCStreetguy/atom-snippet-injector",
   "license": "MIT",
   "engines": {