update docs, add screenshot

This commit is contained in:
Matthias Kretschmann 2019-05-19 15:24:25 +02:00
parent a91a05b9ed
commit 3baaf1aa47
Signed by: m
GPG Key ID: 606EEEF3C479A91F
4 changed files with 55 additions and 19 deletions

View File

@ -1,13 +1,32 @@
# ocean-balance <h1 align="center">
Blowfish
</h1>
<p align="center">
<strong>🐡 Simple Electron-based desktop app to retrieve and display your total <a href="https://oceanprotocol.com">Ocean Token</a> balances.</strong>
</p>
<p align="center">
<a href="https://travis-ci.com/kremalicious/blowfish"><img src="https://travis-ci.com/kremalicious/blowfish.svg?branch=master" /></a>
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/kremalicious/blowfish.svg" /></a>
</p>
> 🐡 Simple Electron-based desktop app to retrieve and display your total Ocean Token balances. ![interface](https://user-images.githubusercontent.com/90316/57982435-f0098a80-7a45-11e9-96c0-903830c8d42a.png)
> https://oceanprotocol.com
<p align="center">
Made with ♥ by <a href="https://matthiaskretschmann.com">Matthias Kretschmann</a>
</p>
<p align="center">
<small>Say thanks with OCEAN or ETH: <code>0xf50F267b5689b005FE107cfdb34619f24c014457</code></small>
<br />
<small>Say thanks with BTC: <code>3DiHNMt875UWa2j73qFpr3cVB9foFhYArc</code></small>
</p>
--- ---
- [Features](#features) - [Features](#features)
- [Usage](#usage) - [Download](#download)
- [Development](#development)
- [Build packages](#build-packages) - [Build packages](#build-packages)
- [License](#license)
--- ---
@ -19,15 +38,27 @@
- re-fetches everything automatically every minute - re-fetches everything automatically every minute
- balances are fetched via etherscan.io API - balances are fetched via etherscan.io API
- spot prices are fetched from coingecko.com API - spot prices are fetched from coingecko.com API
- currently highly optimized for macOS, your mileage on Windows or Linux may vary
## Usage ## Download
Clone, add adresses, and run: You can download pre-built binaries for macOS, Linux, and Windows from the [Releases page](https://github.com/kremalicious/blowfish/releases).
The binaries are not code-signed so opening them on macOS will result in a warning. To be able to get around this warning:
1. Right-click on the app icon, and choose _Open_
2. In the dialog, click _Open_
Alternatively, you can [build the app on your system](#build-packages).
## Development
Clone, and run:
```bash ```bash
# Clone this repository # Clone this repository
git clone git@github.com:kremalicious/ocean-balance.git git clone git@github.com:kremalicious/blowfish.git
cd ocean-balance cd blowfish
# Install dependencies # Install dependencies
npm install npm install
@ -38,13 +69,17 @@ npm start
## Build packages ## Build packages
```bash ```bash
npm run build npm run dist
``` ```
Will build and package the app into platform specific packages for macOS, Windows & Linux. Will build and package the app into platform specific packages for macOS, Windows & Linux.
On a Mac and Linux machine, packaging requires [`wine`](https://www.winehq.org) in your `PATH`. To install on macOS with [Homebrew](https://brew.sh): On a Mac and Linux machine, packaging requires [`wine`](https://www.winehq.org) and `rpm` in your `PATH`. To install on macOS with [Homebrew](https://brew.sh):
```bash ```bash
brew install wine brew install wine rpm
``` ```
## License
[The MIT License](./LICENSE)

View File

@ -1,6 +1,6 @@
{ {
"name": "ocean-balance", "name": "blowfish",
"productName": "Ocean", "productName": "Blowfish",
"version": "1.0.0", "version": "1.0.0",
"description": "🐡 Simple Electron-based desktop app to retrieve and display your total Ocean Token balances.", "description": "🐡 Simple Electron-based desktop app to retrieve and display your total Ocean Token balances.",
"main": "./src/main.js", "main": "./src/main.js",
@ -11,8 +11,8 @@
"package": "electron-builder build -mwl && open ./dist", "package": "electron-builder build -mwl && open ./dist",
"dist": "npm run build && npm run package" "dist": "npm run build && npm run package"
}, },
"repository": "https://github.com/kremalicious/ocean-balance.git", "repository": "https://github.com/kremalicious/blowfish.git",
"homepage": "https://github.com/kremalicious/ocean-balance", "homepage": "https://github.com/kremalicious/blowfish",
"author": { "author": {
"name": "Matthias Kretschmann", "name": "Matthias Kretschmann",
"email": "m@kretschmann.io", "email": "m@kretschmann.io",
@ -62,8 +62,7 @@
}, },
"browserslist": "electron >= 5.0", "browserslist": "electron >= 5.0",
"build": { "build": {
"productName": "Ocean Balance", "appId": "com.kremalicious.blowfish",
"appId": "com.kremalicious.ocean-balance",
"files": [ "files": [
"./build/**/*", "./build/**/*",
"./src/*.js", "./src/*.js",

View File

@ -1,9 +1,10 @@
import './Titlebar.css' import './Titlebar.css'
import React from 'react' import React from 'react'
import pkg from '../../../package.json'
const Titlebar = () => ( const Titlebar = () => (
<header className="titlebar"> <header className="titlebar">
<span className="header-title">Ocean</span> <span className="header-title">{pkg.productName}</span>
</header> </header>
) )

View File

@ -1,6 +1,7 @@
const path = require('path') const path = require('path')
const { app, BrowserWindow, systemPreferences } = require('electron') const { app, BrowserWindow, systemPreferences } = require('electron')
const { touchBarWrapper } = require('react-touchbar-electron') const { touchBarWrapper } = require('react-touchbar-electron')
const pkg = require('../package.json')
const buildMenu = require('./menu') const buildMenu = require('./menu')
let mainWindow let mainWindow
@ -32,7 +33,7 @@ const createWindow = async () => {
backgroundColor: isDarkMode ? '#141414' : '#fff', backgroundColor: isDarkMode ? '#141414' : '#fff',
frame: false, frame: false,
show: false, show: false,
title: 'Ocean Balance', title: pkg.productName,
webPreferences: { webPreferences: {
nodeIntegration: true, nodeIntegration: true,
scrollBounce: true scrollBounce: true