Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Anton-4 committed Feb 21, 2024
1 parent 97baf24 commit 1f3a0d7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@

# Json Package for Roc 🤘

## Example

Try running some of the examples using Roc cli.

:warning: `--linker=legacy` is necessary for this package because of [this roc issue](https://github.com/roc-lang/roc/issues/3609)

## Example

```sh
$ roc run examples/simple1.roc --linker=legacy
Successfully decoded image, title:"View from 15th Floor"
Expand All @@ -16,7 +14,7 @@ Successfully decoded image, title:"View from 15th Floor"

See [https://lukewilliamboswell.github.io/roc-json/](https://lukewilliamboswell.github.io/roc-json/)

Alternatively, you can also generate docs locally using `roc docs package/main.roc` and then serve the html files.
Alternatively, generate docs locally using `roc docs package/main.roc` and then serve the html files.

## Package URL Release

Expand Down

0 comments on commit 1f3a0d7

Please sign in to comment.