Skip to content

Commit 44ae947

Browse files
lhawkman27lhawkinsclaude
authored
Fix up README with logo, badges, and visual assets (#326)
* #320 update README with GeoSet logo, badges, and visual assets - Replace placeholder title with centered GeoSet logo - Add badges: License, Based on Superset, PostGIS, Docker, deck.gl - Add hero image (Hurricane Helene storm data dashboard) - Add dashboard demo gif, feature showcase grid (metrics, point sizing, ruler/tooltip, clustering), and example dashboard screenshot - Remove all TODO placeholders - Convert .mov videos to .gif for inline GitHub rendering Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 fix logo rendering and normalize gif heights - Convert SVG logo to PNG for reliable GitHub rendering - Set matching height (260px) on ruler and clustering gifs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 refine README layout and add color-by-category and text-overlay screenshots Left-align logo, reduce feature table image widths to prevent horizontal scroll, add point size scaling to feature list, and include two new feature screenshots. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 widen dashboard demo gif to 850px Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 widen feature screenshot table images to 410px Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 widen demo gif, swap text overlay screenshot, and adjust table image sizes Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 remove unused geoset-text-overlay.png image Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 fix typo in color-by-category screenshot filename Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 replace dashboard demo GIF with MP4, add conditional zoom visibility screenshot - Swap dashboard demo from GIF to MP4 video for smaller size and better quality - Add conditional zoom visibility GIF to feature showcase table - Add Features & Functionality subheading and TOC entry - Remove unused geoset-example-dashboard-demo.gif Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 add layer toggling screenshot and update wiki Home page - Add layer toggling GIF to feature showcase table in README - Update wiki Home.md: add dynamic point sizing to feature comparison table and add JSON Config Spec to Pages list Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 revert dashboard demo to GIF, add text overlay layer to wiki - Revert dashboard demo from MP4 video back to GIF (wider at 1000px) - Remove unused geoset-example-dashboard-demo.mp4 - Add missing Storm Track Points Text Overlay layer to wiki Sample-Dashboards.md Hurricane Tracker section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * #320 update README features list with text overlay and point size scaling clarification Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: lhawkins <lhawkins@teamraft.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 925481d commit 44ae947

16 files changed

Lines changed: 63 additions & 11 deletions

README.md

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
1-
# GeoSet
1+
<img src="docs/images/geoset-logo.png" alt="GeoSet" width="300" />
22

3-
TODO: LOGO!
3+
<p align="center">
44

55
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0)
6+
[![Based on Superset](https://img.shields.io/badge/Based%20on-Apache%20Superset-orange.svg)](https://github.com/apache/superset)
7+
[![PostGIS](https://img.shields.io/badge/PostGIS-Compatible-brightgreen.svg)](https://postgis.net/)
8+
[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED.svg?logo=docker&logoColor=white)](https://www.docker.com/)
9+
[![deck.gl](https://img.shields.io/badge/deck.gl-Powered-purple.svg)](https://deck.gl/)
610

7-
TODO: MORE BANNERS
8-
TODO: WE NEED TO RECREATE THE PICTURES WITH THE GEOSET LOGO
11+
</p>
12+
13+
<p align="center">
14+
<img src="docs/images/helene-storm-data.png" alt="GeoSet Dashboard - Hurricane Helene Storm Data" width="800" />
15+
</p>
916

1017
__GeoSet brings robust geospatial visualization capabilities to [Apache Superset](https://github.com/apache/superset) with native [PostGIS](https://postgis.net/) compatibility.__
1118

1219
- [What is GeoSet?](#what-is-geoset)
20+
- [Features \& Functionality](#features--functionality)
1321
- [How GeoSet Differs from Apache Superset](#how-geoset-differs-from-apache-superset)
1422
- [Quick Start](#quick-start)
1523
- [Step 1 - Create a Copy of docker/.env.example](#step-1---create-a-copy-of-dockerenvexample)
1624
- [Step 2 - Launch Docker Compose](#step-2---launch-docker-compose)
25+
- [Alternative Docker Image](#alternative-docker-image)
1726
- [Step 3 - Open GeoSet and Explore](#step-3---open-geoset-and-explore)
1827
- [Contributing](#contributing)
1928
- [Development Guide](#development-guide)
@@ -25,11 +34,52 @@ GeoSet bridges the gap between Superset and GIS tooling. This is accomplished by
2534
- Single and multilayer maps
2635
- Visibility toggling by zoom
2736
- Hover over and additional details pane
28-
- Color by category or value
37+
- Color by category or value (either can be used with Point Size Scaling)
38+
- Point size scaling by value (number or percentile bounds)
2939
- Collapsible legend with layer toggling and dynamic iconography
3040
- Native dashboard integration
31-
32-
TODO: PUT PRETTY PICTURES HERE
41+
- Text Overlay Formatting
42+
43+
<p align="center">
44+
<img src="docs/images/geoset-example-dashboard-demo.gif" alt="GeoSet Example Dashboard Demo" width="1000" />
45+
</p>
46+
47+
### Features & Functionality
48+
49+
<table>
50+
<tr>
51+
<td align="center"><strong>Color by Metric</strong></td>
52+
<td align="center"><strong>Dynamic Point Sizing</strong></td>
53+
</tr>
54+
<tr>
55+
<td><img src="docs/images/wind-metrics-chart.png" alt="Wind Metrics Chart" width="390" /></td>
56+
<td><img src="docs/images/wildfire-point-size-scaling.png" alt="Wildfire Point Size Scaling" width="390" /></td>
57+
</tr>
58+
<tr>
59+
<td align="center"><strong>Ruler &amp; Tooltip</strong></td>
60+
<td align="center"><strong>Point Clustering</strong></td>
61+
</tr>
62+
<tr>
63+
<td><img src="docs/images/ruler-tooltip-in-action.gif" alt="Ruler and Tooltip in Action" width="390" height="245" /></td>
64+
<td><img src="docs/images/point-clustering-example.gif" alt="Point Clustering Example" width="390" height="245" /></td>
65+
</tr>
66+
<tr>
67+
<td align="center"><strong>Color by Category</strong></td>
68+
<td align="center"><strong>Text Overlay</strong></td>
69+
</tr>
70+
<tr>
71+
<td><img src="docs/images/geoset-color-by-category.png" alt="Color by Category" width="390" /></td>
72+
<td><img src="docs/images/geoset-text-overlay-2.png" alt="Text Overlay" width="390" /></td>
73+
</tr>
74+
<tr>
75+
<td align="center"><strong>Conditional Zoom Visibility</strong></td>
76+
<td align="center"><strong>Layer Toggling</strong></td>
77+
</tr>
78+
<tr>
79+
<td><img src="docs/images/conditional-zooming-layer-visibility.gif" alt="Conditional Zoom Visibility" width="390" /></td>
80+
<td><img src="docs/images/layer-toggling-multi-chart.gif" alt="Layer Toggling" width="390" /></td>
81+
</tr>
82+
</table>
3383

3484
## How GeoSet Differs from Apache Superset
3585

@@ -67,9 +117,9 @@ DOCKERFILE=Dockerfile.rhel docker compose up
67117

68118
### Step 3 - Open GeoSet and Explore
69119

70-
We've created an example dashboard accessible at [http://localhost:9001/superset/dashboard/geoset-example-dashboard](http://localhost:9001/superset/dashboard/geoset-example-dashboard).
120+
We've created an example dashboard accessible at [http://localhost:9001/superset/dashboard/geoset-example-dashboard](http://localhost:9001/superset/dashboard/geoset-example-dashboard).
71121

72-
TODO: put pictures here
122+
![GeoSet Example Dashboard](docs/images/geoset-example-dashboard.png)
73123

74124
## Contributing
75125

1.57 MB
Loading
190 KB
Loading
9.05 MB
Loading
436 KB
Loading

docs/images/geoset-logo.png

20.8 KB
Loading
248 KB
Loading

docs/images/helene-storm-data.png

999 KB
Loading
390 KB
Loading
2.64 MB
Loading

0 commit comments

Comments
 (0)