Comunic/ComunicAPI
1
0
Fork 0
mirror of https://github.com/pierre42100/ComunicAPI synced 2024-11-27 07:49:27 +00:00
Code Issues Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Pierre HUBERT 2019-01-26 08:22:15 +01:00
parent f57a57482b
commit f99e16c23e
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,10 +4,14 @@ This project is the main Comunic RestAPI. It assures data backend support.
(c) Pierre HUBERT since 2017 (c) Pierre HUBERT since 2017
# Crons required for Comunic
Currently, this server does not make use of crons.
# Use calls in Comunic
To use calls in Comunic, you need a WebRTCSignalExchangerServer, a small signal exchanging server written using NodeJS. You also need to modify your configuration file located at `config/overwrite.php` by copying and pasting commented configuration located at `config/calls.php` and make it fit your needs.
### Add API clients # Add API clients
In order to easily add clients to the API, a script has been created. In order to easily add clients to the API, a script has been created.
bin/add_client [name] [token] bin/add_client [name] [token]
Note : The name of the client must be unique, and the token should the strongest Note : The name of the client must be unique, and the token should the strongest