Skip to content

Commit

Permalink
chore: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sindrel committed Feb 18, 2023
1 parent e407210 commit 456d373
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,18 @@ Excalidraw Converter ports Excalidraw diagrams to a Gliffy compatible format, wh

![Excalidraw vs. Gliffy comparison](exconv-comparison.png "Comparison")

## Getting started
## Getting started

### Installation
#### MacOS with [Homebrew](https://brew.sh/)
```shell
brew install sindrel/tap/excalidraw-converter
```

#### Installation for other OSes
Download a compatible binary from the [Releases](https://github.com/sindrel/excalidraw-converter/releases) page.

If you're a Linux or MacOS user, move it to your local bin folder to make it available in your environment (optional).
If you're a Linux or MacOS user, move it to your local bin folder to make it available in your environment (optional).

### How to convert diagrams
First save your Excalidraw diagram to a file.
Expand All @@ -24,7 +29,7 @@ Then, to do a conversion, simply execute the binary by specifying the `gliffy` c
<summary>MacOS example</summary>

```
$ ./exconv gliffy ~/Downloads/my-diagram.excalidraw /tmp/my-ported-diagram.gliffy
$ exconv gliffy ~/Downloads/my-diagram.excalidraw /tmp/my-ported-diagram.gliffy
Parsing input file: ~/Downloads/my-diagram.excalidraw
Adding object: com.gliffy.shape.basic.basic_v1.default.rectangle
Adding object: com.gliffy.shape.basic.basic_v1.default.text
Expand Down

0 comments on commit 456d373

Please sign in to comment.