@openglobus/openglobus-react 0.1.0 → 0.1.2

package/README.md

@@ -1,52 +1,35 @@
-# React port for OpenGlobus
-Openglobus React Components
+# 🌍 React Components for [OpenGlobus](https://github.com/openglobus/openglobus)
+
+## Features:
+- **Core Entities**: A complete set of core entities to work with geospatial data, including billboards, 3d-objects, polylines, labels and more.
+- **Reactive Integration**: Seamlessly integrate with React applications, leveraging the reactive style.
+- **Performance**: Enhanced performance through efficient data handling and rendering optimizations.
+- **Storybook**: Explore and interact with all components and features in our [Storybook](https://openglobus.github.io/storybook), providing a comprehensive showcase and testing environment.
+- **Minimal Dependencies**: Designed with minimal dependencies to ensure lightweight and efficient performance.
+
+## Install:
 
-Install:
 ```bash
 npm i @openglobus/openglobus-react
 ```
 
-Example of usage: 
+## Usage:
+
+Super easy to try out – just run:
+
+```bash 
+npx create openglobus
+```
+
+## Documentation:
+For detailed documentation and examples, please refer to our [Storybook](https://openglobus.github.io/storybook).
+
+## License:
+This project is licensed under the MIT License - see the LICENSE.md file for details.
+
 
-`App.tsx`
-```tsx
-import '@openglobus/openglobus-react/dist/style.css'
-import Globus, {GlobeContextProvider} from '@openglobus/openglobus-react'
 
 
-function App() {
-    return <GlobeContextProvider>
-        <Globus/>
-    </GlobeContextProvider>
-}
 
-export default App
 
 
-```
-`Button.tsx`
-```tsx
-import {useGlobusContext} from '@openglobus/openglobus-react'
-// import './buttons.css'
-import {LonLat} from "@openglobus/og";
-
-
-export default function ButtonContainer() {
-    const {globus} = useGlobusContext()
-    const clickFlyTo = () => {
-        let ell = globus?.planet.ellipsoid;
-
-        let destPos = new LonLat(10.13176, 46.18868, 10779);
-        let viewPoi = new LonLat(9.98464, 46.06157, 3039);
-        if (ell) {
-            let lookCart = ell.lonLatToCartesian(viewPoi);
-            let upVec = ell.lonLatToCartesian(destPos).normalize();
-            globus?.planet.camera.flyLonLat(destPos, lookCart, upVec, 0);
-        }
-    }
-
-    return <div className={'button-container'}>
-        <button onClick={clickFlyTo}>Fly to</button>
-    </div>
-}
-```