0.1.0 release

CHANGES.md

@@ -4,7 +4,7 @@ Changelog
 All notable changes to this project will be documented in this file.
 
 
- v0.1.0  [unreleased]
+ [v0.1.0]  - 2020-03-29
 ---------------------------------
 
 * initial version released

README.md

@@ -114,47 +114,44 @@ Janus-sentinel is often deployed along with the Janus server on the same machine
 6 Installation
 ----------------
 
-Janus-cloud supports python 3.5 and up. It's strongly recommanded to install Janus-cloud in a python virtual environment, like "venv". 
+Before installation, the following requrements must be satisfied.
 
-### Install from PyPi
+- Python >= 3.5
+- pip
+- setuptools 
 
-To install Janus-cloud from PyPi, 
 
-``` {.sourceCode .bash}
-$ python pip install janus-cloud
-```
+Janus-cloud supports python 3.5 and up. It's strongly recommanded to install Janus-cloud in a python virtual environment, like "venv". 
+
+### Install from PyPi 
 
-To install the static resources of janus-cloud, like sample configuration, default cert, test html pages, 
+To install Janus-cloud from PyPi, 
 
 ``` {.sourceCode .bash}
-$ python janus-install-conf <install_dir>
+$ pip install janus-cloud
 ```
-where <install_dir> is the install directory which would contains the resources in your system.
 
 ### Install from source
 
-To install Janus-cloud from project source, type the following shell command at the project's root directly:
+To install Janus-cloud from project source
 
 ``` {.sourceCode .bash}
-$ python setup.py install
+$ pip install <project_root>
 ```
 
+Where <project_root> is the root directory of project source, which contians the setup.py file
+
 For developer, who want to debug the Janus-cloud, and install it for develop mode:
 
 ``` {.sourceCode .bash}
-$ python setup.py develop
+$ pip install -e <project_root>
 ```
 
 7 Configure and Start
 ---------------------------
 
-If installed from source, some sample configuration files (with explanations) are shipped within the project source at <Project root>/conf. 
-
-If installed from PyPi, you can type the following command, which would install the sample configuration files, the certifications, test html page and other static resource into the specific directory of your system.
-
-``` {.sourceCode .bash}
-$ python janus-install-conf <install_dir>
-```
+Some resource files, like sample configuration(with explanations), html test scripts, and etc, are shipped within the project source. 
+After installation, these resource would be installed under ** <sys.prefix>/opt/janus-cloud ** where <sys.prefix> is the root diriectory of your filesystem. or the the root directory of virtual environment if install in a virtual environment. 
 
 ### janus-sentinel
 
@@ -164,7 +161,6 @@ Edit the configuration file of Janus-sentinel, then type the following commands
 $ janus-sentinel <janus-sentinel config file path>
 ```
 
-
 ### janus-proxy
 
 Edit the configuration file of Janus-proxy, then type the following commands to start.
@@ -181,8 +177,8 @@ By now, Janus-proxy / Janus-sentinel only suport corresponding with the backend
 In summary, there are some requirements below on the configuration of the backend Janus sever when deploying with Janux-cloud:
 
 * WebSocket transport must be enabled to correspond with Janus-proxy/Janus-sentinel
-* api_secret and token_auth which are used for the api security must be disabled 
-* admin_secret must be disabled
+* api_secret and token_auth feature must be disabled 
+* admin_secret feature must be disabled
 
 
 9 Directory structure of project source
@@ -195,8 +191,6 @@ janus-cloud/
     |
     +----conf/            Sample configuration files
     |
-    +----cert/            Default certification for wss
-    |
     +----html/            Html & js page code for test client
     |
     +----januscloud/      Pythond code package of janus-cloud

januscloud/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '0.1.0a2'
+__version__ = '0.1.0'