travel3dglobe 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fabien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# Travel3DGlobe
+
+A reusable 3D globe component with a visual config editor that can export/import `globe-config.json`.
+
+## Editor App
+
+Hosted editor (Vercel): `<VERCEL_APP_URL>`
+
+This app lets you tune globe settings visually and export a config JSON for use in your own project.
+
+## Install
+
+From npm:
+
+```bash
+npm install <NPM_PACKAGE_NAME>
+```
+
+From GitHub:
+
+```bash
+npm install github:<GITHUB_USER>/<GITHUB_REPO>#<TAG_OR_BRANCH>
+```
+
+## Component Usage
+
+```js
+import { createGlobe } from '<NPM_PACKAGE_NAME>';
+
+const globe = await createGlobe({
+  container: document.getElementById('globe-root'),
+  config: {
+    highlightCodes: ['USA', 'CAN', 'MEX']
+  }
+});
+
+// optional runtime updates
+await globe.setConfig({ showGrid: false, haloColor: '#33aaff' });
+
+// optional: export current runtime config object
+const cfg = globe.getConfig();
+
+// required on unmount / cleanup
+globe.destroy();
+```
+
+Required:
+- `container`: DOM element where the globe is mounted
+
+Optional:
+- `config`: partial globe config (missing fields use defaults)
+- `enableDebugPanel`: `true | false` (default `true` in editor host usage)
+
+Notes:
+- Globe size follows the container size.
+- Use CSS for responsive or fixed dimensions of the container.
+- `globeScale` changes globe size inside the canvas, not the canvas size itself.
+
+## Project Structure
+
+- `src/index.js`: package exports
+- `src/core/globeComponent.js`: embeddable globe lifecycle/API
+- `src/config/globeConfig.js`: config defaults + migration/normalization
+- `src/debug/controls.js`: editor GUI
+- `src/main.js`: editor/demo app entry
+
+## License
+
+`<LICENSE_TYPE>` (for example `MIT`). See `LICENSE`.
+
+## Contributing
+
+Contributions are welcome via issues and pull requests.