Skip to content

Commit

Permalink
bump up version to 0.0.8
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Jul 11, 2019
1 parent dd8bafc commit b876727
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ and interacts with the main thread via [`SharedArrayBuffer`][shared-array-buffer
- Vim exits on `:quit`, but it does not close a browser tab. Please close it
manually :)

The current ported Vim version is 8.1.1655.
The current ported Vim version is 8.1.1658.

The goal of this project is running Vim editor on browser by compiling Vim C sources
into WebAssembly.
Expand Down
21 changes: 20 additions & 1 deletion wasm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,26 @@ be enabled manually for now to enable them. Please also read notices in README.m
Following projects are related to this npm package and may be more suitable for your use case.
- [react-vim-wasm](https://github.com/rhysd/react-vim-wasm): [React](https://reactjs.org/) component for [vim.wasm][project].
Vim editor can be embeded in your React web application.
Vim editor can be embedded in your React web application.
## Check Browser Compatibility
This npm package runs Vim in Web Worker and the main thread communicates with the worker thread via `SharedArrayBuffer`.
Chrome or Chromium based browser supports `SharedArrayBuffer` by default. Safari and Firefox supports it under a feature
flag due to Spectre vulnerability.
To check current browser can use this package, `checkBrowserCompatibility()` utility function is provided.
It returns an error message as string if it is not compatible (otherwise returns `undefined`).
```javascript
const errmsg = checkBrowserCompatibility();
if (errmsg !== undefined) {
alert(errmsg);
return;
}
const vim = new VimWasm({...});
```
## Logging
Expand Down
2 changes: 1 addition & 1 deletion wasm/example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"author": "rhysd <[email protected]> (https://rhysd.github.io)",
"license": "Vim",
"dependencies": {
"vim-wasm": "^0.0.7"
"vim-wasm": "^0.0.8"
},
"devDependencies": {
"http-server": "^0.11.1"
Expand Down
2 changes: 1 addition & 1 deletion wasm/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vim-wasm",
"version": "0.0.7",
"version": "0.0.8",
"description": "Vim editor ported to WebAssembly",
"type": "module",
"main": "vimwasm.js",
Expand Down

0 comments on commit b876727

Please sign in to comment.