electerm 1.10.4 → 1.18.3

package/README.md

@@ -7,7 +7,7 @@
 # electerm
 
 [![GitHub version](https://img.shields.io/github/release/electerm/electerm/all.svg)](https://github.com/electerm/electerm/releases)
-[![Build Status](https://travis-ci.org/electerm/electerm.svg?branch=release)](https://travis-ci.org/electerm/electerm)
+[![GitHub Actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fatrox%2Fsync-dotenv%2Fbadge)](https://github.com/electerm/electerm/actions)
 [![license](https://img.shields.io/github/license/electerm/electerm.svg)](https://github.com/electerm/electerm/blob/master/LICENSE)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![Get it from the Snap Store](https://img.shields.io/badge/Snap-Store-green)](https://snapcraft.io/electerm)
@@ -18,57 +18,79 @@ Terminal/ssh/sftp client(linux, mac, win) based on electron/ssh2/node-pty/xterm/
   <img src="https://github.com/electerm/electerm-resource/raw/master/static/images/electerm.gif", alt="" />
 </div>
 
+## Features
+
+- Works as a terminal/file manager or ssh/sftp client(similar to xshell)
+- Global hotkey to toggle window visibility (similar to guake, default is `ctrl + 2`)
+- Multi platform(linux, mac, win)
+- 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 🇯🇵 🇸🇦 Multi-language support([electerm-locales](https://github.com/electerm/electerm-locales), contributions/fixes welcome)
+- Double click to directly edit (small) remote files.
+- Edit (small) local files with built-in editor.
+- Auth with publicKey + password.
+- Zmodem(rz, sz).
+- Transparent window(Mac, win).
+- Terminal background image.
+- Global/session proxy.
+- Quick commands
+- Sync bookmarks/themes/quick commands to github/gitee secret gist
+- ~~Serial Port support~~(removed after version 1.10.14)
+- Quick input to one or all terminals.
+- Command line usage: check [wiki](https://github.com/electerm/electerm/wiki/Command-line-usage)
+- Zip/transfer/auto-unzip folders.
+
 ## Download/install
 
 - [https://electerm.github.io/electerm](https://electerm.github.io/electerm)
 - From release: [https://github.com/electerm/electerm/releases](https://github.com/electerm/electerm/releases)
-- For some linux OS, rpm pack may not work, you can try the `.snap` release.
-- For Mac user: `brew cask install electerm`
-- With snap: `sudo snap install electerm`
-- For Deepin Linux user, you can find it from App store.
+- For Mac user: `brew install --cask electerm`
+- With snap: `sudo snap install electerm --classic`
+- For some Linux distribution, you can find it from OS default App store(Ubuntu, Deepin, Mint...).
+- For some linux OS, the `rpm`, `deb`, or `snap` release may not work, you can try the `tar.gz` release.
+- For Windows users, you can install it from [windows store](https://www.microsoft.com/store/apps/9NCN7272GTFF), command-line installer [winget](https://github.com/microsoft/winget-cli) and [scoop](https://github.com/lukesampson/scoop) is also recommended:
+
+```powershell
+# winget https://github.com/microsoft/winget-cli
+winget install electerm
+
+# scoop https://github.com/lukesampson/scoop
+scoop bucket add dorado https://github.com/chawyehsu/dorado
+scoop install dorado/electerm
+```
+
 - Install from npm
 
 ```bash
 npm i -g electerm
 
-# after install it will open at once for windows and linux,
-# for mac, will open the drag to install panel
+# after installation, it will immediately open for windows and linux,
+# for macOS, it will open the drag to install panel
 
 ```
 
 ## Upgrade
 
-- Auto upgrade: When new version released, you will get upgrade notification after you start electerm again, then you click the upgrade button to upgrade.
+- Auto upgrade: When a new version is released, you will get an upgrade notification after you start electerm again. You can then click the upgrade button to upgrade.
 - Download: Just download the latest edition, reinstall.
 - Npm: If you install from npm, just run `npm i -g electerm` again.
+- If use Snap or some other distribution system, these systems may provide upgrades.
 
-## Features
+## Known issues
 
-- Work as a terminal/file manager or ssh/sftp client(similar to xshell)
-- Global hotkey to toggle window visibility (simliar to guake, default is `ctrl + 2`)
-- Multi platform(linux, mac, win)
-- 🇺🇸 🇨🇳 🇧🇷 🇷🇺 🇪🇸 🇫🇷 🇹🇷 🇭🇰 Support multi-language([electerm-locales](https://github.com/electerm/electerm-locales), contribute/fix welcome)
-- Double click to directly edit remote file(small ones).
-- Edit local file with built-in editor(small ones).
-- Auth with publickey + password.
-- Zmodem(rz, sz).
-- Transparent window(Mac, win).
-- Terminal background image.
-- Global/session proxy.
-- Quick commands
-- Sync bookmarks/themes/quick commands to github/gitee secret gist
-- Serial Port support
-- Quick input
+[https://github.com/electerm/electerm/wiki/Know-issues](https://github.com/electerm/electerm/wiki/Know-issues)
+
+## Troubleshoot
+
+[https://github.com/electerm/electerm/wiki/Troubleshoot](https://github.com/electerm/electerm/wiki/Troubleshoot)
 
 ## Support
 
-Without users's feedbacks/suggestions/pull requests/language files, this project would not get this far, would love to hear from you, please tell me what you think, [submit an issue](https://github.com/electerm/electerm/issues), [send me an email](mailto:zxdong@gmail.com), [create/fix language files](https://github.com/electerm/electerm-locales) or create a pull requests, all welcome.
+Without user feedback/suggestions/pull requests/language files, this project would not get this far.I would love to hear from you, please tell me what you think, [submit an issue](https://github.com/electerm/electerm/issues), [send me an email](mailto:zxdong@gmail.com), [create/fix language files](https://github.com/electerm/electerm-locales) or create pull requests, all are welcome.
 
 ## Dev
 
 ```bash
 # tested in ubuntu16.04+/mac os 10.13+ only
-# need nodejs/npm, suggest using nvm to install nodejs/npm
+# needs nodejs/npm, suggest using nvm to install nodejs/npm
 # https://github.com/creationix/nvm
 # with node 8.6+
 
@@ -76,13 +98,13 @@ git clone git@github.com:electerm/electerm.git
 cd electerm
 npm i
 
-# start webpack dev server, requires 5570 port
+# start webpack dev server, requires port 5570
 npm start
 
 # in a separate terminal session run app
 npm run app
 
-# lint
+# code format check
 npm run lint
 
 # code format fix

package/npm/install.js

@@ -51,12 +51,11 @@ async function runLinux () {
   await down(releaseInfo.browser_download_url)
   // await down('http://192.168.0.67:7500/electerm-0.16.1.tar.gz')
   exec(`mv ${target} ${targetNew}`)
-  exec(`echo "npm" > ${targetNew}/resources/install-src.txt`)
   exec('electerm')
 }
 
 async function runMac () {
-  const releaseInfo = await getReleaseInfo(r => /\.dmg$/.test(r.name))
+  const releaseInfo = await getReleaseInfo(r => /mac-x64\.dmg$/.test(r.name))
   await down(releaseInfo.browser_download_url, false)
   // await down('http://192.168.0.67:7500/electerm-0.16.1-mac.dmg', false)
   const target = resolve(__dirname, '../', releaseInfo.name)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electerm",
-  "version": "1.10.4",
+  "version": "1.18.3",
   "description": "Terminal/ssh/sftp client(linux, mac, win) based on electron/ssh2/node-pty/xterm/antd/subx and other libs",
   "main": "app.js",
   "bin": "npm/electerm",
@@ -10,6 +10,8 @@
   },
   "license": "MIT",
   "langugeRepo": "https://github.com/electerm/electerm-locales",
+  "privacyNoticeLink": "https://github.com/electerm/electerm/wiki/privacy-notice",
+  "knownIssuesLink": "https://github.com/electerm/electerm/wiki/Know-issues",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/electerm/electerm.git"
@@ -46,7 +48,9 @@
       "MouseEvent",
       "WebSocket",
       "FileReader",
-      "CustomEvent"
+      "CustomEvent",
+      "onmessage",
+      "self"
     ]
   }
 }