x_ite-vrml1-parser 0.0.0-stage → 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/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ # The MIT License (MIT)
2
+
3
+ Copyright (c) 2009 Holger Seelig and other contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,38 @@
1
- # Temporary Holding Version
1
+ # x_ite-vrml1-parser
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![npm Version](https://img.shields.io/npm/v/x_ite-vrml1-parser)](https://www.npmjs.com/package/x_ite-vrml1-parser)
4
+ [![Build Size](https://img.shields.io/bundlephobia/minzip/x_ite-vrml1-parser)](https://bundlephobia.com/package/x_ite-vrml1-parser)
5
+ [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/x_ite-vrml1-parser/badge?style=rounded)](https://create3000.github.io/jsdelivr-download-stats/?username=create3000&repository=x_ite-vrml1-parser)
6
+ [![npm Downloads](https://img.shields.io/npm/dm/x_ite-vrml1-parser)](https://npmtrends.com/x_ite-vrml1-parser)
7
+
8
+ VRML1 File Format Parser for [X_ITE](https://create3000.github.io/x_ite/)
9
+
10
+ ## Usage
11
+
12
+ Include the script before X_ITE:
13
+
14
+ ```html
15
+ <script defer src="https://cdn.jsdelivr.net/npm/x_ite-vrml1-parser@1.0.1/dist/x_ite-vrml1-parser.min.js"></script>
16
+ <script defer src="https://cdn.jsdelivr.net/npm/x_ite@VERSION/dist/x_ite.min.js"></script>
17
+ <!-- or as ES module -->
18
+ <script type="module" src="https://cdn.jsdelivr.net/npm/x_ite-vrml1-parser@1.0.1/dist/x_ite-vrml1-parser.min.js"></script>
19
+ <script type="module" src="https://cdn.jsdelivr.net/npm/x_ite@VERSION/dist/x_ite.min.mjs"></script>
20
+ ```
21
+
22
+ You can now load VRML1 `.vrml` or `.wrl` files directly using the `src` attribute, but you can also use `.vrml` or `.wrl` files as source of an Inline node.
23
+
24
+ ```html
25
+ <x3d-canvas src="room.vrml"></x3d-canvas>
26
+ ```
27
+
28
+ ## NPM
29
+
30
+ You can also install it from npm:
31
+
32
+ ```sh
33
+ npm i x_ite-vrml1-parser
34
+ ```
35
+
36
+ ## License
37
+
38
+ x_ite-vrml1-parser is free software and licensed under the [MIT License](LICENSE.md).