diff --git a/openvidu-components-angular/README.md b/openvidu-components-angular/README.md index a5d979fb..cb1fd113 100644 --- a/openvidu-components-angular/README.md +++ b/openvidu-components-angular/README.md @@ -1,33 +1,7 @@ -# OpenviduComponents +# Openvidu Angular + +The easier way to build powerfull OpenVidu videoconference frontend applications. + +![OpenVidu application](app.gif) -## Architechture - -``` -openvidu-components-angular -│ -└─── src (openvidu-components-testapp) -│ -└───projects - │ - └─── openvidu-angular -``` - -## Development server - -Run `ng serve` for a dev server. - -Run, in a new terminal, `npm run lib:serve` for serving the openvidu-angular library with live reload - -## Code scaffolding - -For generate new components in openvidu-angular: - -```bash -ng g component components/component-name --project=openvidu-angular -``` - - -## Build - -Run `npm run lib:build` to build the library.See more [here](projects/openvidu-components-angular/README.md) diff --git a/openvidu-components-angular/package.json b/openvidu-components-angular/package.json index ca1993e8..de84a3f2 100644 --- a/openvidu-components-angular/package.json +++ b/openvidu-components-angular/package.json @@ -12,7 +12,7 @@ "lib:test": "ng test openvidu-angular --no-watch --code-coverage", "lib:e2e": "tsc --project ./e2e && npx mocha --recursive --timeout 30000 ./e2e/dist/angular.test.js", "lib:e2e-ci": "cross-env LAUNCH_MODE=CI npm run lib:e2e", - "lib:doc-build": "npx compodoc -p src/doc/tsconfig.doc.json -c src/doc/.compodocrc.json", + "lib:doc-build": "npx compodoc -p src/doc/tsconfig.doc.json -c src/doc/.compodocrc.json && rm -rf ../../openvidu.io-docs/docs/api/openvidu-angular && cp -r ./docs/openvidu-angular/ ../../openvidu.io-docs/docs/api/openvidu-angular", "lib:doc-serve": "npx compodoc -p src/doc/tsconfig.doc.json --watch --serve -c src/doc/.compodocrc.json", "webcomponent:build": "./node_modules/@angular/cli/bin/ng.js build openvidu-webcomponent --configuration production && node ./openvidu-webcomponent-build.js", "webcomponent:serve-testapp": "npx http-server ./e2e/webcomponent-app/", diff --git a/openvidu-components-angular/projects/openvidu-angular/README.md b/openvidu-components-angular/projects/openvidu-angular/README.md index 13fabeda..3502ba67 100644 --- a/openvidu-components-angular/projects/openvidu-angular/README.md +++ b/openvidu-components-angular/projects/openvidu-angular/README.md @@ -6,6 +6,33 @@ This library is an Angular library based on Angular projections ## Code scaffolding +## Architechture + +``` +openvidu-components-angular +│ +└─── src (openvidu-components-testapp) +│ +└───projects + │ + └─── openvidu-angular +``` + +## Development server + +Run `ng serve` for a dev server. + +Run, in a new terminal, `npm run lib:serve` for serving the openvidu-angular library with live reload + +## Code scaffolding + +For generate new components in openvidu-angular: + +```bash +ng g component components/component-name --project=openvidu-angular +``` + + ## Build ```bash diff --git a/openvidu-components-angular/src/doc/.compodocrc.json b/openvidu-components-angular/src/doc/.compodocrc.json index a4708540..cb307775 100644 --- a/openvidu-components-angular/src/doc/.compodocrc.json +++ b/openvidu-components-angular/src/doc/.compodocrc.json @@ -15,5 +15,6 @@ "disableDependencies": true, "theme": "gitbook", "customFavicon": "src/favicon.ico", - "extTheme": "src/doc/" + "extTheme": "src/doc/", + "assetsFolder": "src/assets/images/app.gif" }