Skip to content

Commit

Permalink
Add example image to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@dudewad
dudewad committed Sep 11, 2024
1 parent 520f2ce commit 371a4eb
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

`starfinder` is a Rust & Python package that provides functionality to read, process, and render star data from the Tycho-2 catalog. It's built with Rust for performance and exposes a Python API for ease of use.

![Starfinder output](https://raw.githubusercontent.com/djmango/starfinder/master/example_output.png "Example Starfinder Output")

<small>Pictured above: Example Starfinder output</small>

## Setup

1. Download the Tycho-2 catalog:
Expand Down

0 comments on commit 371a4eb

Please sign in to comment.