geoai 0.0.7 → 1.0.0-rc.1

package/CHANGELOG.md

@@ -1,10 +1,31 @@
 # Changelog
 
-All notable changes to the @geobase.js/geoai project will be documented in this file.
+All notable changes to the geoai project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-rc.1] - 2024-01-XX
+
+### Release Candidate
+This is the first release candidate for version 1.0.0. This RC includes all the features and improvements planned for the final 1.0.0 release.
+
+## [1.0.0] - 2024-01-XX
+
+### Changed
+- **BREAKING**: Renamed package from `geoai-js` to `geoai`
+- Updated all import statements and package references
+- Updated build output structure from `geoai-js.js` to `geoai.js`
+- Updated documentation and examples
+- Updated repository URLs and homepage
+
+### Migration Guide
+To migrate from the old package:
+1. Update your package.json: `"geoai-js": "^0.0.7"` → `"geoai": "^1.0.0"`
+2. Update all import statements: `import { geoai } from "geoai"` → `import { geoai } from "geoai"`
+3. Update any build configurations that reference the old package name
+4. Update any documentation or scripts that reference the old package
+
 ## [0.0.7] - 2024-12-19
 
 ### Fixed
@@ -27,7 +48,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial public release of @geobase.js/geoai
+- Initial public release of geoai
 - Support for multiple Geo AI models:
   - Object Detection
   - Building Footprint Segmentation

package/README.md

@@ -1,13 +1,13 @@
-[![Main](https://github.com/decision-labs/geobase.js/actions/workflows/main.yml/badge.svg)](https://github.com/decision-labs/geobase.js/actions/workflows/main.yml)
+[![Main](https://github.com/decision-labs/geoai.js/actions/workflows/main.yml/badge.svg)](https://github.com/decision-labs/geoai.js/actions/workflows/main.yml)
 
-# `@geobase.js/geoai`
+# GeoAI
 
-A Javascript library for running Geo AI models in frontend applications.
+A JavaScript library for running Geo AI models in frontend applications.
 
 ## Installation
 
 ```bash
-npm install @geobase.js/geoai
+npm install geoai
 ```
 
 ## Usage
@@ -15,7 +15,7 @@ npm install @geobase.js/geoai
 ### Core Library (Node.js and Browser)
 
 ```javascript
-import { geoai } from "@geobase.js/geoai";
+import { geoai } from "geoai";
 
 // Initialize the pipeline
 const pipeline = await geoai.pipeline([{ task: "object-detection" }], {
@@ -34,34 +34,71 @@ const result = await pipeline.inference({
 });
 ```
 
-## Architecture
+### React Hooks
 
-- **Core Module** (`@geobase.js/geoai`): Pure Javascript/TypeScript library that works in both Node.js and browser environments
-
-## API Reference
-
-### Core API
+```javascript
+import { useGeoAIWorker } from "geoai/react";
+
+function MyComponent() {
+  const { inference, isLoading, error } = useGeoAIWorker({
+    tasks: ["object-detection"],
+    provider: "geobase",
+    apikey: "your-api-key",
+  });
+
+  const handleInference = async () => {
+    const result = await inference({
+      inputs: { polygon: geoJsonFeature },
+      mapSourceParams: { zoomLevel: 18 },
+    });
+  };
+
+  return (
+    <div>
+      <button onClick={handleInference} disabled={isLoading}>
+        {isLoading ? "Processing..." : "Run Detection"}
+      </button>
+      {error && <div>Error: {error.message}</div>}
+    </div>
+  );
+}
+```
 
-- `geoai.pipeline(tasks, config)` - Initialize a pipeline with tasks
-- `pipeline.inference(params)` - Run inference with the pipeline
+## Features
 
+- **Multiple AI Tasks**: Object detection, segmentation, classification, and more
+- **Map Provider Support**: Geobase, Mapbox, ESRI, and Google Maps
+- **React Integration**: Hooks for easy React integration
+- **TypeScript Support**: Full TypeScript definitions
+- **Web Worker Support**: Run AI models in background threads
+- **Optimized Performance**: Efficient model loading and inference
 
 ## Supported Tasks
 
 - Object Detection
-- Building Footprint Segmentation
-- Land Cover Classification
-- Zero-shot Object Detection
-- Oriented Object Detection
-- Oil Storage Tank Detection
+- Building Detection
+- Car Detection
 - Ship Detection
 - Solar Panel Detection
+- Oil Storage Tank Detection
+- Land Cover Classification
 - Wetland Segmentation
+- Building Footprint Segmentation
 - Mask Generation
-- Car-Detection
+- Zero-shot Object Detection
+- Zero-shot Segmentation
+- Image Feature Extraction
 
-## License
+For more see the [supported tasks](https://docs.geobase.app/geoai/supported-tasks)
+
+## Documentation
 
-MIT
+Visit [docs.geobase.app/geoai](https://docs.geobase.app/geoai) for comprehensive documentation, examples, and API reference.
+
+## Contributing
+
+We welcome contributions! Please see our [contributing guide](CONTRIBUTING.md) for details.
+
+## License
 
-~~togglebuild~~
+MIT License - see [LICENSE.md](LICENSE.md) for details.