From 3c7fbd314c032e2e453b3057f95def4ef5a84eec Mon Sep 17 00:00:00 2001 From: "ipcjs.wsl2" Date: Fri, 12 Apr 2024 01:37:24 +0800 Subject: [PATCH] wip: update readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d07ee40f..f19a7a26 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,23 @@ https://user-images.githubusercontent.com/11886731/213943491-97211b41-c130-4b6b- ## Using Yarle via command line + Just open a terminal, specify config options in a config file (options detailed in [Configuration](#Configuration)) and type the following: -```javascript -npx -p yarle-evernote-to-md@latest yarle --configFile +```sh +npx -p yarle-evernote-to-md@latest yarle --configFile ./config.json # path to your config file ``` +You can also override properties in the configuration file with command-line arguments. Note that only properties of types like `string`, `string[]`, and `boolean` can be overridden. + +```sh +npx -p yarle-evernote-to-md@latest yarle \ + --configFile ./config.json \ + --enexSources ./test.enex \ + --outputDir out-new +``` + + ## Yarle intro and usage videos on Youtube: How to migrate notes from Evernote to Obsidian (using Yarle)
YARLE: A lifeline to escape from Evernote @@ -193,7 +204,7 @@ The following configurational properties are available: | |Property Name| Property value | Meaning | |-------------|----------------|---------| -|```enexSources```| multiple enex files, or a folder of the enex files(if you specify it via command line) | specifies the exported Evernote notebook(s) as an absolute path| +|```enexSources```| multiple enex files, or a folder of the enex files | specifies the exported Evernote notebook(s) as an absolute path| |```templateFile``` | path of your custom template file | if its not specified, a [default template](https://github.com/akosbalasko/yarle/blob/master/src/utils/templates/default-template.ts) will be used |```outputDir``` | path to your output dir (absolute or relative) | this is the main output dir where the extracted markdown files and the external resources, images, pdf-s are going to be created| |```resourcesDir``` | `_resources` | subdir where attachments/external resources will be placed