react-three-map 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 react-three-map authors
+
+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,67 @@
+# React Three Map
+
+⚠️ **Alpha Warning: This library is currently in its alpha phase. While functional, it's still under active development and may have bugs. Please use with caution in production and feel free to report any issues you encounter. Thank you for your understanding!**
+
+
+React Three Map seamlessly integrates three.js with Mapbox, allowing you to bring the power of 3D rendering to your maps.
+This package offers a Three layer that allows you to use `@react-three/fiber` within `react-map-gl` and is compatible with both Mapbox and Maplibre.
+
+## Installation
+
+You can install React Three Map via npm:
+
+```bash
+npm install react-three-map
+```
+
+
+## Getting Started
+
+Just add `<Canvas>` inside the map and start using R3F as usual :)
+
+```jsx
+import { ReactMapGL, StaticMap } from 'react-map-gl';
+import { Canvas } from 'react-three-map';
+
+<ReactMapGL {...viewport} >
+  <Canvas>
+    {/* Use react-three-fiber as usual in here */}
+    <mesh>
+      <boxBufferGeometry attach="geometry" args={[1, 1, 1]} />
+      <meshStandardMaterial attach="material" color="orange" />
+    </mesh>
+  </Canvas>
+</ReactMapGL>
+...
+```
+
+## Documentation
+
+For a full API reference, more usage examples, and other information, check out the full React [Three Map Documentation](#todo).
+
+## Contributing
+
+We encourage you to contribute to React Three Map! Please check out the [Contributing to React Three Map guide](#todo) for guidelines about how to proceed.
+
+## License
+
+React Three Map is [MIT licensed](#todo).
+
+## Support
+
+f you're having a problem with anything related to this library, we encourage you to reach out to us. We're always happy to help resolve issues and answer any questions you might have. Open an issue on our [Github repo](#todo).
+
+Remember to always follow the Code of Conduct when interacting with the community.
+
+## Enjoy Using React Three Map!
+
+We hope that you enjoy using React Three Map as much as we enjoyed building it. Happy coding!
+
+## Roadmap
+
+- [ ] Use ThreeJS as a Map Layer.
+- [ ] Use ThreeJS as a canvas overlay.
+- [ ] Add stencil buffers to occlude from the map.
+- [ ] Fully decompose the projection matrix into all the Camera properties required.
+- [ ] Support post processing.
+- [ ] Support multiple coordinate transformations using only one ThreeJS renderer.