-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
830057b
commit d2fe475
Showing
1 changed file
with
12 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,57 @@ | ||
| The LiquidCore Project | ||
| ---------------------- | ||
|
|
||
| LiquidCore enables Node.js virtual machines to run inside Android and iOS apps. It provides a complete runtime environment, including a virtual file system and native SQLite3 support. | ||
| LiquidCore enables [Node.js] virtual machines to run inside Android and iOS apps. It provides a complete runtime environment, including a virtual file system. | ||
|
|
||
| LiquidCore also provides a convenient way for Android developers to [execute raw JavaScript](https://github.com/LiquidPlayer/LiquidCore/wiki/LiquidCore-as-a-Native-Javascript-Engine) inside of their apps, as iOS developers can already do natively with JavaScriptCore. | ||
|
|
||
| For a description of how to use LiquidCore, please see the appropriate README under [LiquidCoreAndroid](https://github.com/LiquidPlayer/LiquidCore/tree/master/LiquidCoreAndroid) or [LiquidCoreiOS](https://github.com/LiquidPlayer/LiquidCore/tree/master/LiquidCoreiOS). | ||
|
|
||
| Version | ||
| ------- | ||
| [0.5.1](https://github.com/LiquidPlayer/LiquidCore/releases/tag/0.5.1) | ||
| [0.6.0](https://github.com/LiquidPlayer/LiquidCore/releases/tag/0.6.0) | ||
|
|
||
| [](https://jitpack.io/#LiquidPlayer/LiquidCore) | ||
| [](https://jitpack.io/#LiquidPlayer/LiquidCore) | ||
| [](https://github.com/Carthage/Carthage) | ||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| API Documentation | ||
| ----------------- | ||
| **Android Javadocs**: [Version 0.5.1](https://liquidplayer.github.io/LiquidCoreAndroid/0.5.1/index.html) | ||
| **Android Javadocs**: [Version 0.6.0](https://liquidplayer.github.io/LiquidCoreAndroid/0.6.0/index.html) | ||
|
|
||
| **iOS Objective-C/Swift**: [Version 0.5.1](https://liquidplayer.github.io/LiquidCoreiOS/0.5.1/index.html) | ||
| **iOS Objective-C/Swift**: [Version 0.6.0](https://liquidplayer.github.io/LiquidCoreiOS/0.6.0/index.html) | ||
|
|
||
| Architecture | ||
| ------------ | ||
|
|
||
| The diagrams below generally represent reality, although they are aligned with the vocabulary that will be used in version 0.6.0. Add-ons are currently referred to as "surfaces" in versions 0.5.x, but this will change shortly. | ||
|
|
||
| ### Android | ||
|
|
||
|  | ||
|
|
||
| LiquidCore for Android includes the Node.js runtime and V8 backend. In addition, it provides three APIs for apps to interact with: | ||
|
|
||
| * **[Java / JavaScript JNI](https://liquidplayer.github.io/LiquidCoreAndroid/0.5.1/org/liquidplayer/javascript/package-frame.html) API**, which provides a convenient way to run raw JavaScript code from within Java, without the need for a clunky `WebView`. | ||
| * **Node [`Process`](https://liquidplayer.github.io/LiquidCoreAndroid/0.5.1/org/liquidplayer/node/Process.html) API**, which allows developers to launch fast isolated instances of the Node.js runtime | ||
| * **[`MicroService`](https://liquidplayer.github.io/LiquidCoreAndroid/0.5.1/org/liquidplayer/service/MicroService.html) API**, which is an abstraction of a Node.js process and supports dynamic code fetching and native plugins | ||
| * **[Java / JavaScript JNI](https://github.com/LiquidPlayer/LiquidCore/wiki/README-Android-(0.6.0)#java--javascript-api) API**, which provides a convenient way to run raw JavaScript code from within Java, without the need for a clunky `WebView`. | ||
| * **Node [`Process`](https://github.com/LiquidPlayer/LiquidCore/wiki/README-Android-(0.6.0)#node-process) API**, which allows developers to launch fast isolated instances of the Node.js runtime. | ||
| * **[`MicroService`](https://github.com/LiquidPlayer/LiquidCore/wiki/README-Android-(0.6.0)#the-microservice) API**, which is an abstraction of a Node.js process and supports dynamic code fetching and native add-ons. | ||
|
|
||
| Native plugins enable extending the basic runtime environment with additional native functionality. Plugins have access to all the above APIs, plus the ability to use [WebKit's JavaScriptCore API](https://developer.apple.com/documentation/javascriptcore?language=objc) running on top of V8. This allows projects that depend on JavaScriptCore, like [React Native](https://facebook.github.io/react-native/), to use LiquidCore directly. | ||
| Native add-ons enable extending the basic runtime environment with additional native functionality. Add-ons have access to all the above APIs, plus the ability to use [WebKit's JavaScriptCore API](https://developer.apple.com/documentation/javascriptcore?language=objc) running on top of V8. This allows projects that depend on JavaScriptCore, like [React Native](https://facebook.github.io/react-native/), to use LiquidCore directly. | ||
|
|
||
| ### iOS | ||
|
|
||
|  | ||
|
|
||
| LiquidCore for iOS includes the Node.js runtime, but without the V8 backend. Instead, it marshalls calls to V8 through an interpreter to Apple's JavaScriptCore engine. It provides two APIs for apps to interact with: | ||
|
|
||
| * **Node `LCProcess` API**, which allows developers to launch fast isolated instances of the Node.js runtime | ||
| * **[`LCMicroService`](https://liquidplayer.github.io/LiquidCoreiOS/0.5.1/Classes/LCMicroService.html) API**, which is an abstraction of a Node.js process and supports dynamic code fetching and native plugins | ||
|
|
||
| Native add-ons enable extending the basic runtime environment with additional native functionality. Plugins have access to the above APIs, plus the ability to use the V8 API. This allows projects that depend on V8, such native Node modules to use LiquidCore directly. | ||
| * **Node [`LCProcess`](https://github.com/LiquidPlayer/LiquidCore/wiki/README-iOS-(0.6.0)#node-lcprocess) API**, which allows developers to launch fast isolated instances of the Node.js runtime. | ||
| * **[`LCMicroService`](https://github.com/LiquidPlayer/LiquidCore/wiki/README-iOS-(0.6.0)#the-lcmicroservice) API**, which is an abstraction of a Node.js process and supports dynamic code fetching and native add-ons. | ||
|
|
||
| Note: The `LCProcess` API is not exposed publicly in versions 0.5.x and below. It will be in 0.6+. | ||
| Native add-ons enable extending the basic runtime environment with additional native functionality. Add-ons have access to the above APIs, plus the ability to use the V8 API. This allows projects that depend on V8, such native Node modules to use LiquidCore directly. | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| Copyright (c) 2014 - 2018 LiquidPlayer | ||
| Copyright (c) 2014 - 2019 LiquidPlayer | ||
|
|
||
| Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for terms and conditions. | ||
|
|
||
| [Node.js]:https://nodejs.org/ | ||
| [Android Studio]:https://developer.android.com/studio/index.html | ||
| [BigNumber]:https://github.com/MikeMcl/bignumber.js/ |