Update description and badge in main README.md (#18)

* Update description to say GeoTIFF instead of TIFF Heading in main README.md now says GeoTIFF instead of TIFF. Added this description to the Cargo.toml file and crate level docs in src/lib.rs. * Update badge to point to crates.io 0.0.2 version Also update version in Cargo.toml and Cargo.lock files.
georust · Sep 9, 2024 · b7a36af · b7a36af
1 parent 03b2b6a
commit b7a36af
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "geotiff"
-version = "0.0.1"
+description = "A GeoTIFF library for Rust"
+version = "0.0.2"
 edition = "2021"
 authors = ["Dominik Bucher <[email protected]>"]
 repository = "https://github.com/georust/geotiff"

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# A TIFF Library for Rust
+# A GeoTIFF library for Rust
 
-![Version](https://img.shields.io/badge/version-v0.0.2-red.svg)
+[![geotiff on crates.io](https://img.shields.io/crates/v/geotiff.svg)](https://crates.io/crates/geotiff)
 
 > [!IMPORTANT]
 > This crate is currently undergoing a significant refactoring process to be built on

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,4 @@
+//! A [GeoTIFF](https://www.ogc.org/standard/geotiff) library for Rust
 use std::any::type_name;
 use std::io::{Read, Seek};