fix: Added code README

Author: sjhoeksma

.vscode/cody.json

@@ -0,0 +1,17 @@
+{
+    "Improve variable names": {
+        "prompt": "Suppose that you are writing code for a production level application which is shared by many developers in your team. Take the current code, and update the variable names so that it should improve the readability of the code and help the other developers maintain it without much difficulty.",
+        "context": {
+            "codebase": false,
+            "selection": true
+        }
+    },
+    "readme": {
+        "description": "Readme for current dir",
+        "prompt": "Write a detailed README.md file to document the code located in the same directory as my current selection. Summarize what the code in this directory is meant to accomplish. Explain the key files, functions, classes, and features. Use Markdown formatting for headings, code blocks, lists, etc. to make the it organized and readable. Aim for a beginner-friendly explanation that gives a developer unfamiliar with the code a good starting point to understand it. Make sure to include: - Overview of directory purpose - Functionality explanations - Relevant diagrams or visuals if helpful. Write the README content clearly and concisely using complete sentences and paragraphs based on the shared context. Use proper spelling, grammar, and punctuation throughout. Surround your full README text with triple backticks so it renders properly as a code block. Do not make assumptions or fabricating additional details.",
+        "context": {
+            "currentDir": true,
+            "selection": true
+        }
+    }
+}

README.md

@@ -0,0 +1,82 @@
+# GEOComp Component
+
+The `src` directory contains the source code for the GEOComp React component. GEOComp renders an interactive geographic map using the OpenLayers library.
+
+## Overview
+
+GEOComp is a reusable map component that can be configured and integrated into other applications. It allows displaying geographic data layers, interactivity through popups and drawing, and exposes events for integrating custom functionality.
+
+Some key capabilities provided by GEOComp:
+
+- Configurable base map layers
+- Overlay vector data layers from files or API sources  
+- Interaction through popups, selection, and drawing tools
+- Expose map events and selected features
+- Timeline animation of temporal data
+- Customizable styling
+
+## Key Files
+
+Within the main directory you will find the following files creating the lowcoder plugin
+
+- `GEOComp.tsx` - Main component definition and configuration
+- `LayersControl.tsx` - Builds layer configuration UI
+- `FeaturesControl.tsx` - Feature flags configuration  
+- `vendors/index.ts` - OpenLayers map initialization and helpers
+- `styles.module.css` - Component styling
+
+## Component Configuration
+
+GEOComp is configured through React props that control the map options and layers. Some key configuration props:
+
+- `center` - Initial center point [lon, lat]
+- `zoom` - Initial zoom level
+- `layers` - Array of layer configuration objects
+- `events` - Object mapping event names to handlers
+- `feature` - Selected/edited feature state  
+
+## Events and Interactivity
+
+GEOComp exposes events that can be handled in the parent component:
+
+- `onInit` - Map initialized
+- `onLoad` - Layers loaded
+- `onClick` - Map clicked
+- `onSelect` - Feature clicked
+- `onModify` - Draw layer edited
+
+This allows integrating custom popup content, selection logic, etc.
+
+## Styling
+
+GEOComp uses CSS modules for styling control. The `styles` prop accepts configuration for:
+
+- Padding
+- Text sizing
+- Background color 
+- Borders
+- Border radius
+
+This allows adapating the visual style.
+
+# Building the plugin
+
+Before you start make your you have a up-to-date version on node installed locally.
+
+Start with cloning the repository on to you local hard drive. Install all dependecies and start te component test environment. Make any changes to the code you want and the will be visible in the test environment. 
+
+```bash
+git clone https://github.com/sjhoeksma/lowcoder-comp-geo.git
+cd lowcoder-comp-geo
+yarn install
+yarn start
+```
+
+When you are finished you can build your own version or deploy it to npmjs
+
+```bash
+# Building
+yarn build 
+# Or Publishing
+yarn build --publish
+```

README.md

@@ -12,25 +12,3 @@ To help you with understanding how you can use this plugin we have added an [exa
 
 #### Viewer
 ![viewer](https://github.com/sjhoeksma/lowcoder-comp-geo/blob/main/images/viewer-example.png?raw=true)
-
-# Development
-
-Before you start make your you have a up-to-date version on node installed locally.
-
-Start with cloning the repository on to you local hard drive. Install all dependecies and start te component test environment. Make any changes to the code you want and the will be visible in the test environment. 
-
-```bash
-git clone https://github.com/sjhoeksma/lowcoder-comp-geo.git
-cd lowcoder-comp-geo
-yarn install
-yarn start
-```
-
-When you are finished you can build your own version or deploy it to npmjs
-
-```bash
-# Building
-yarn build 
-# Or Publishing
-yarn build --publish
-```