Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andersevenrud committed May 21, 2021
1 parent 223128f commit dde572b
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,36 +40,41 @@ There's also a [contribution guide](https://github.com/os-js/OS.js/blob/master/C

> OS.js runs on `http://localhost:8000` by default.
### Demo
### Using a pre-made image

You can run a demo using Docker without checking out any source-code:
You can use the official Docker base image to run OS.js without downloading this repository.

This image is based on this source code and comes with a minimal setup.

```bash
docker run -p 8000:8000 osjs/osjs:latest
```

### Custom
### Using this repository

Clone the master branch:

Clone the master branch of the official OS.js repository:
> You can also download an archived version (ex. zip file) instead of using git.
```bash
git clone -b master --single-branch https://github.com/os-js/OS.js.git
cd OS.js
```

#### Docker
#### Docker Compose installation

You can run OS.js locally without installing anything on your host system if you have Docker and Docker Compose installed.

Simply run the following command and a complete environment will be set up for you:
The easiest way to install is to use Docker Compose. This allows you to run a single command
to set everything up:

```bash
docker-compose up
```

#### Locally
#### Local installation

You can also install this directly onto your system by using the following set of commands.

To install directly on the host system you'll need Node 10 (or later).
> **NOTE:** Requires Node v10 (or later).
```bash
# Install dependencies
Expand Down

0 comments on commit dde572b

Please sign in to comment.