Skip to content

Commit

Permalink
Update README & refactor actions
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikKalkoken committed Jul 6, 2024
1 parent aa228a5 commit f2f25ca
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 9 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
if-no-files-found: error
overwrite: true

package_darwin:
package_windows:
if: startsWith(github.ref, 'refs/tags/')
needs: test
runs-on: windows-latest
Expand Down Expand Up @@ -108,7 +108,7 @@ jobs:
if-no-files-found: error
overwrite: true

package_macos:
package_darwin:
if: startsWith(github.ref, 'refs/tags/')
runs-on: macos-latest
needs: test
Expand Down Expand Up @@ -147,7 +147,7 @@ jobs:

release:
if: startsWith(github.ref, 'refs/tags/')
needs: [package_linux, package_macos, package_darwin]
needs: [package_linux, package_darwin, package_windows]
runs-on: ubuntu-latest
permissions: write-all
steps:
Expand Down
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
# JSON Viewer

This is a desktop app to view large JSON file. It runs on Windows 10/11, Mac OS X and Linux.
JSON Viewer is a desktop app for browsing large JSON files. It runs on Linux, Windows 10/11 and Mac OS X (Experimental).

If your system is configured to run [Fyne](https://fyne.io/) apps, you can start this app directly from the command line with:
[![GitHub Release](https://img.shields.io/github/v/release/ErikKalkoken/jsonviewer)](https://github.com/ErikKalkoken/jsonviewer)
[![build status](https://github.com/ErikKalkoken/jsonviewer/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/ErikKalkoken/jsonviewer/actions/workflows/ci-cd.yml)
[![GitHub License](https://img.shields.io/github/license/ErikKalkoken/jsonviewer)](https://github.com/ErikKalkoken/jsonviewer)

## Installation

Please follow the instructions below to install JSON viewer on your platform.

### Linux

tbd.

### Windows

tbd.

### MAC

tbd.

### Build and run on-the-fly

If your system is configured to run [Fyne](https://fyne.io/) apps, you can build and run this app directly from the command line:

```sh
go run github.com/ErikKalkoken/jsonviewer@latest
Expand All @@ -12,11 +34,9 @@ For more information on how to configure your system for Fyne please see: [Getti

This app is currently under development. Use at your own risk.

## Performance

We tested JSON Viewer with large files. Here is what we found so far:
## Application performance

- 350MB with 20M elements => works and uses about 6.5 GB RAM
JSON viewer is designed to view and browse large JSON files. We found that the key limiting factor for viewing large JSON files is physical RAM. For example on a Linux laptop with 8 GB RAM we were able to view JSON files with ~350 MB size and ~20M elements. Viewing a file of that size consumed ~6.5 GB of RAM, which was about the maximum amount of memory available to applications on that system.

## Attributions

Expand Down

0 comments on commit f2f25ca

Please sign in to comment.