Skip to content

Add preview section to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tabries merged 2 commits into from
Mar 10, 2026
Merged

Add preview section to README #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd1d476
Add preview section to README
tabries Mar 9, 2026
7ee513f
Add space above link to GitHub assets in README
tabries Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ An interactive dashboard for visualizing global climate data in real time, combi
![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)
![License](https://img.shields.io/badge/License-MIT-yellow)

## Preview

3D Map and climate visual information
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor grammar/style: "3D Map and climate visual information" reads a bit awkwardly and lacks punctuation. Consider rephrasing to something like "3D globe and climate visualizations." to improve clarity.

Suggested change
3D Map and climate visual information
3D globe and climate visualizations

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preview text says "3D Map", but elsewhere the README describes the 3D experience as a "3D Globe" (and the 2D piece as the map). Consider renaming this line to match the terminology used in the Features section to avoid confusing readers about what the preview shows.

Suggested change
3D Map and climate visual information
3D Globe and climate visualization preview

Copilot uses AI. Check for mistakes.

https://github.com/user-attachments/assets/f13717b2-56f5-4287-aa7e-9b60c8e30d84
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preview asset is presented as a bare URL, which is less readable and less accessible in markdown. Consider converting it to a descriptive markdown link (or embedding an image/video preview if appropriate) so screen readers and readers scanning the README know what the link points to.

Suggested change
https://github.com/user-attachments/assets/f13717b2-56f5-4287-aa7e-9b60c8e30d84
![3D map and climate visual dashboard preview](https://github.com/user-attachments/assets/f13717b2-56f5-4287-aa7e-9b60c8e30d84)

Copilot uses AI. Check for mistakes.

---

## Features
Expand Down
Loading