Skip to content

Commit

Permalink
Chore: readme updated, logo added, etc.
Browse files Browse the repository at this point in the history
akosbalasko authored Sep 2, 2020
2 parents ac9a719 + e591363 commit 4da2633
Showing 4 changed files with 20 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -4,4 +4,5 @@ coverage
node_modules
dist
out
.DS_Store
.DS_Store
.wakatime-project
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

![logo](screens/yarle-logo.png)

# yarle: Yet Another Rope Ladder from Evernote

@@ -18,11 +19,12 @@ A tool that converts enex note(s) into Markdown format in order to let you escap

## Installation

- [install Node.js](https://nodejs.org/en/download/). Please use Node 10.18.1 because of 3rd party dependencies rebuild problems.
0. [Install Node.js](https://nodejs.org/en/download/).

- clone or download this repo
- npm i
- npm run build
1. Clone or download this repo.
2. Open a terminal and navigate to the root folder of the repo.
3. Type `npm i`, it installs the dependencies.
4. Type `npm run build` to build the package.

## Usage:

@@ -61,6 +63,17 @@ Those markdown notes that contains external resources such pictures or files, ar

## Release notes

### Version 2.9.0

- NodeJs version limitation resolved.
- Feature requested in [Issue#39](https://github.com/akosbalasko/yarle/issues/39) implemented: the conversion returns the number of the failed notes if any.
- Logo added to readme.
- Previously if unit tests were executed in timezone differs from Western Europe, they were failed. It's fixed now.
- Bug reported in [Issue#39](https://github.com/akosbalasko/yarle/issues/39) fixed.
- Action added to test Yarle in different Node versions.

Special thanks to [Rodrigo Vieira](https://github.com/rodbv) for the contribution!

### Version 2.8.0

- New command-line argument introduced : `--outputFormat`. Its optional, one possible value is `ObsidianMD` that configures Yarle to generate internal file links and highlights in Obsidian-style.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "yarle-evernote-to-md",
"version": "2.8.0",
"version": "2.9.0",
"description": "Yet Another Rope Ladder from Evernote",
"keywords": [
"evernote",
Binary file added screens/yarle-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4da2633

Please sign in to comment.