Skip to content
This repository was archived by the owner on Dec 12, 2021. It is now read-only.

Commit 1639ace

Browse files
committed
Update Howto
1 parent 30f429f commit 1639ace

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

HOWTO.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
---
44

5-
## Examples
5+
## Using the snippet-injector
6+
67
### Create
78
(_[Reference](README.md#commands)_)
89

@@ -58,3 +59,33 @@ The snippet is now deleted from the local Atom storage.
5859

5960

6061
---
62+
63+
## Using the IMEX module
64+
65+
The IMEX (shorthand for 'IMport and EXport') module provides import and export
66+
functionalities. It ships with several format configurations and parsing methods.
67+
To access it, open the `Packages` menu and navigate down to the submenu
68+
`Snippet Injector`. There you should find the options `Import Snippets` and
69+
`Export Snippets` (which is a submenu).
70+
71+
### Exporting
72+
(_[Reference](README.md#commands)_)
73+
74+
To export your snippets, open the named submenu `Export Snippets` and
75+
select a format of your choise. (All available formatting options can be found [here](README.md#snippet-injectorexport-to-))
76+
Afterwards you will be prompted for a saving location and the file will be stored there.
77+
78+
### Importing
79+
(_[Reference](README.md#commands)_)
80+
81+
To import previously exported data, select the `Import Snippets` option in the menu.
82+
You will be prompted for a file to import from. The format is recognized automatically,
83+
the file contents get parsed accordingly and are stored as new snippets.
84+
85+
86+
### Please notice!
87+
If you want to import data back later on, make sure you choose a format
88+
that is stated as "importable" and **_not for a moment_ touch the file contents!**
89+
The IMEX module does not recognize invalid data and will parse everything within
90+
the given file. This may result in Fatal Errors or broken snippets.
91+
> *Don't complain later, I told you so...*

0 commit comments

Comments
 (0)