Skip to content
This repository was archived by the owner on Jul 3, 2020. It is now read-only.

Commit 30abc90

Browse files
committed
Update README.md
1 parent e647c0f commit 30abc90

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
[![Build Status](https://travis-ci.org/runtimejs/runtime.svg?branch=master)](https://travis-ci.org/runtimejs/runtime) [![npm](https://img.shields.io/npm/v/runtimejs.svg)](https://www.npmjs.com/package/runtimejs) [![Gem](https://img.shields.io/badge/freenode-%23runtimejs-blue.svg)](https://freenode.net/) [![Travis](https://img.shields.io/badge/GITTER-JOIN_CHAT_%E2%86%92-1dce73.svg)](https://gitter.im/runtimejs/runtime)
44

5-
__runtime.js__ is an open-source library operating system for the cloud that runs JavaScript, could be bundled up with an application and deployed as a lightweight and immutable VM image.
5+
__runtime.js__ is an open-source library operating system (unikernel) for the cloud that runs JavaScript, can be bundled up with an application and deployed as a lightweight and immutable VM image.
66

77
It's built on [V8 JavaScript engine](https://code.google.com/p/v8/) and uses event-driven and non-blocking I/O model inspired by [Node.js](https://nodejs.org/). At the moment [KVM](http://www.linux-kvm.org/page/Main_Page) is the only supported hypervisor.
88

9+
It tries to be compatible with npm module ecosystem and supports some of the Node.js API.
10+
11+
_WARNING: project is in development and not ready for production use._
12+
913
### Installation
1014

1115
First thing is the command line tool `runtime-cli`, it will add `runtime` command to the shell. Type `runtime` to get full usage help.
@@ -14,7 +18,7 @@ First thing is the command line tool `runtime-cli`, it will add `runtime` comman
1418
npm install runtime-cli -g
1519
```
1620

17-
Make sure QEMU VM is installed, so you can test/debug applications locally.
21+
Make sure QEMU is installed, it enables running applications locally.
1822

1923
```
2024
brew install qemu # OSX
@@ -33,25 +37,25 @@ npm install runtimejs --save
3337
echo "console.log('ok')" > index.js
3438
```
3539

36-
Run project locally in the QEMU VM:
40+
Run project locally in QEMU:
3741

3842
```
3943
runtime start
4044
```
4145

42-
Or let it watch directory for changes and restart QEMU automatically:
46+
That's it, it should start and print `ok` in the console.
47+
48+
Optionally you can let it watch directory for changes and restart QEMU automatically:
4349

4450
```
4551
runtime watch
4652
```
4753

48-
WARNING: runtime.js is in development and not ready for production use. Contributions are welcome.
49-
5054
## How does it work?
5155

5256
There are two main components: operating system kernel and a <a href="https://www.npmjs.com/package/runtimejs"><nobr>JavaScript library</nobr></a>.
5357

54-
The kernel is written in C++ and manages low-level resources like CPU and memory and runs JavaScript code using embedded <a href="https://code.google.com/p/v8/"><nobr>V8 JavaScript engine</nobr></a>.
58+
The kernel is written in C++ and manages low-level resources like CPU and memory, runs JavaScript using embedded V8 engine. Library drives the entire system and manages hardware devices (usually virtualized by hypervisor).
5559

5660
## Docs
5761

0 commit comments

Comments
 (0)