@inovitas/infra3dapi 0.2.3 → 0.2.7

package/README.md

@@ -1,25 +1,64 @@
-# Installation
-### NPM Package
-The api can be installed with npm as a package. To install it from the npm package repository just type:
-```bash
-npm install @inovitas/infra3dapi
-```
-
-### CDN Download
-As alternative you can get the api from a CDN. To get the latest version add the following script into your html file:
-```html
-<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
-```
-We recommend to use a specific version in your project. To get a specific version use the following script and adjust the version to your version:
-```html
-<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@0.1.0/infra3dapi.js"></script>
-```
-
-
-# Core Concept
-To use the api, you can call the init functions in infra3dapi. After loggin in and initializing the view (with [`manager.initView()`](classes/_inovitas_infra3dapi.manager.Manager.html#initView)), you will get a viewer object from the sdk. This viewer object can then be used to add event-listeners to different events emitted by the viewer (like [`viewer.geoframechanged`](classes/_inovitas_infra3dsdk.Viewer.html#geoframechanged)) or to call some functions (like [`viewer.getRoutes()`](classes/_inovitas_infra3dsdk.Viewer.html#getRoutes) or [`viewer.movePosition()`](classes/_inovitas_infra3dsdk.Viewer.html#movePosition)).
+# Installation
+### NPM Package
+The API can be installed as a package using npm. To install it from the npm package repository, simply type:
+```bash
+npm install @inovitas/infra3dapi
+```
+
+### CDN Download
+Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:
+```html
+<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
+```
+We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:
+```html
+<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@0.1.0/infra3dapi.js"></script>
+```
+**Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
+
+
+# Core Concept
+To use the API, you can call the init functions in infra3dapi. After loggin in and initializing the view (with [`manager.initView()`](classes/_inovitas_infra3dapi.manager.Manager.html#initView)), you will get a viewer object. This viewer object can then be used to add event-listeners to different events emitted by the viewer (like [`viewer.geoframechanged`](classes/_inovitas_infra3dsdk.Viewer.html#geoframechanged)) or to call some functions (like [`viewer.getRoutes()`](classes/_inovitas_infra3dsdk.Viewer.html#getRoutes) or [`viewer.movePosition()`](classes/_inovitas_infra3dsdk.Viewer.html#movePosition)).
+
+
+# Changelog
 
+## 0.2.7 - 04.04.2024
+
+### Added
+
+- Improved documentation
+  - Description of the event types
+  - Description of further settings
+
+### Changed
+
+- Adaptation to the existing examples
+
+## 0.2.4 - 14.03.2024
+
+### Bugfixes
+
+- Troubleshooting with internal module
+
+## 0.2.3 - 09.02.2024
+
+### Added
+
+- Demo Access Login
+- Documenation
+
+### Changed
+
+- Adoption of adjustments to the UI base of infra3D Edit
+
+### Bugfixes
+
+- Various minor adjustments
+
+## 0.2.0 - 30.01.2024
+
+### Added
+
+- Edit functionality
 
-# Changelog
-## 0.1.0 - 22.09.2023
-First MVP release of the new JavaScript API