Skip to content

Commit

Permalink
docs(readme): update install help
Browse files Browse the repository at this point in the history
  • Loading branch information
vzhd1701 committed Aug 20, 2022
1 parent 33cfe1b commit 53c10d6
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,40 @@ Backup your notes & notebooks from Evernote locally and export them at any time!

## Installation

### Using portable binary

[**Download the latest release**](https://github.com/vzhd1701/evernote-backup/releases/latest) for your OS.

### With [Homebrew](https://brew.sh/)
### With [Homebrew](https://brew.sh/) (Recommended for macOS)

```bash
$ brew install evernote-backup
```

### With PIP
### With [PIPX](https://github.com/pipxproject/pipx) (Recommended for Linux & Windows)

```bash
$ pip install evernote-backup
```shell
$ pipx install evernote-backup
```

**Python 3.7 or later required.**

Or, since **evernote-backup** is a standalone tool, it might be more convenient to install it using [**pipx**](https://github.com/pipxproject/pipx):
### With PIP

```bash
$ pipx install evernote-backup
$ pip install --user evernote-backup
```

**Python 3.7 or later required.**

### With Docker

```bash
$ docker run --rm -t -v "$PWD":/tmp ghcr.io/vzhd1701/evernote-backup:latest
$ docker run --rm -t -v "$PWD":/tmp vzhd1701/evernote-backup:latest
```

To log in to Evernote using OAuth with Docker, you'll have to forward port 10500 for a callback:

```bash
$ docker run --rm -t -v "$PWD":/tmp -p 10500:10500 ghcr.io/vzhd1701/evernote-backup:latest init-db --oauth
$ docker run --rm -t -v "$PWD":/tmp -p 10500:10500 vzhd1701/evernote-backup:latest init-db --oauth
```

## Usage
Expand Down

0 comments on commit 53c10d6

Please sign in to comment.