@abi-software/simulationvuer 0.7.0-vue-3-alpha.5 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -1
- package/dist/simulationvuer.js +5030 -4809
- package/dist/simulationvuer.umd.cjs +14 -13
- package/dist/style.css +1 -1
- package/package.json +20 -8
- package/src/App.vue +2 -2
- package/src/components/SimulationVuer.vue +57 -2
- package/vuese-generator.js +128 -0
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ You can now use the SimulationVuer in your Vue template as follows:
|
|
|
45
45
|
<SimulationVuer :apiLocation="apiLocation" :id=123 />
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
where `apiLocation` is the URL to the API location and `id` the id of the dataset.
|
|
48
|
+
where `apiLocation` is the URL to the API location and `id` the id of the simulation-based dataset.
|
|
49
49
|
|
|
50
50
|
## Project setup
|
|
51
51
|
|
|
@@ -79,3 +79,15 @@ npm run build-bundle
|
|
|
79
79
|
|
|
80
80
|
SimulationVuer is now being developed as a Vue 3 component only.
|
|
81
81
|
The [Vue 2 version of SimulationVuer](https://github.com/ABI-Software/simulationvuer/tree/vue2) is not maintained anymore.
|
|
82
|
+
|
|
83
|
+
## Documentation
|
|
84
|
+
|
|
85
|
+
The documentation is written using [VitePress](https://vitepress.dev/) and [vuese](https://github.com/vuese/vuese#readme), and it can be found in the `docs` folder.
|
|
86
|
+
|
|
87
|
+
#### To run in local development mode
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npm run docs:watch
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
This will start the documentation server with [VitePress](https://vitepress.dev/) on port `5173`: http://localhost:5173/simulationvuer/.
|