[call-me] - update readme

This commit is contained in:
Miroslav Pejic
2024-11-24 10:10:48 +01:00
parent e92dc80151
commit f3a7e9f0b8
5 changed files with 34 additions and 1 deletions
+31
View File
@@ -20,6 +20,10 @@ This project allows you to:
### Quick Start
- #### Using NodeJs
![nodejs](public/assets/nodejs.png)
**[Install Node.js and npm](https://nodejs.org/en/download)**
```shell
@@ -39,6 +43,33 @@ npm install
npm start
```
---
- #### Using Docker
![docker](public/assets/docker.png)
Install [docker engine](https://docs.docker.com/engine/install/) and [docker compose](https://docs.docker.com/compose/install/)
```shell
# Clone this repo
git clone https://github.com/miroslavpejic85/call-me.git
# Go to to dir call-me
cd call-me
# Copy .env.template to .env
cp .env.template .env
# Get official image from Docker Hub
docker-compose pull
# Create and start containers
docker-compose up
```
---
1. Open your browser and visit [http://localhost:8000](http://localhost:8000).
2. Sign in with your username.
+2
View File
@@ -16,6 +16,8 @@
## Installation
![nodejs](../public/assets/nodejs.png)
Install `NodeJS 18.X` and `npm` using [Node Version Manager](https://docs.mirotalk.com/utility/nvm/)
---
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "call-me",
"version": "1.0.17",
"version": "1.0.18",
"description": "Your Go-To for Instant Video Calls",
"author": "Miroslav Pejic - miroslav.pejic.85@gmail.com",
"license": "AGPLv3",
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB