docs: add package overview, installation guide and usage examples to README

Author: Beforerr

README.md

@@ -1,6 +1,46 @@
-# CommonDataFormat
+# CommonDataFormat.jl
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Beforerr.github.io/CommonDataFormat.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Beforerr.github.io/CommonDataFormat.jl/dev/)
-[![Build Status](https://github.com/Beforerr/CommonDataFormat.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Beforerr/CommonDataFormat.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/Beforerr/CommonDataFormat.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Beforerr/CommonDataFormat.jl)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaspacephysics.github.io/CommonDataFormat.jl/dev/)
+[![Build Status](https://github.com/JuliaSpacePhysics/CommonDataFormat.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/CommonDataFormat.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/JuliaSpacePhysics/CommonDataFormat.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSpacePhysics/CommonDataFormat.jl)
+
+A Julia package for reading Common Data Format (CDF) files, widely used in space physics and other scientific domains for storing multidimensional data arrays and metadata.
+
+## Features
+
+- **Pure Julia implementation** - No external dependencies on CDF libraries
+- **Efficient data access** - Lazy loading and direct variable indexing
+
+## Installation
+
+```julia
+using Pkg
+Pkg.add("CommonDataFormat")
+```
+
+## Quick Start
+
+```julia
+using CommonDataFormat
+
+# Load a CDF file
+cdf = CDFDataset("data.cdf")
+
+# Access basic information
+println("CDF version: ", cdf.version)
+println("Data majority: ", cdf.majority)
+println("Compression: ", cdf.compression)
+
+# List all variables
+println("Variables: ", keys(cdf))
+
+# Access a variable
+var = cdf["temperature"]
+println("Variable data: ", var.data)
+println("Data type: ", var.data_type)
+println("Dimensions: ", var.dimensions)
+```
+
+## Elsewhere
+
+- [CDFpp](https://github.com/SciQLop/CDFpp): A modern C++ header only cdf library with Python bindings

docs/make.jl

@@ -8,16 +8,14 @@ makedocs(;
     authors="Beforerr <zzj956959688@gmail.com> and contributors",
     sitename="CommonDataFormat.jl",
     format=Documenter.HTML(;
-        canonical="https://Beforerr.github.io/CommonDataFormat.jl",
-        edit_link="main",
-        assets=String[],
+        canonical="https://juliaspacephysics.github.io/CommonDataFormat.jl",
     ),
     pages=[
         "Home" => "index.md",
     ],
 )
 
 deploydocs(;
-    repo="github.com/Beforerr/CommonDataFormat.jl",
+    repo="github.com/JuliaSpacePhysics/CommonDataFormat.jl",
     devbranch="main",
 )

docs/src/index.md

@@ -2,9 +2,11 @@
 CurrentModule = CommonDataFormat
 ```
 
-# CommonDataFormat
+# CommonDataFormat.jl
 
-Documentation for [CommonDataFormat](https://github.com/Beforerr/CommonDataFormat.jl).
+A Julia package for reading Common Data Format (CDF) files.
+
+## API Reference
 
 ```@index
 ```

test/runtests.jl

@@ -12,6 +12,14 @@ const PROJECT_DATA_PATH = joinpath(@__DIR__, "..", "data")
 # include("basic_tests.jl")
 # include("cdf_file_tests.jl")
 
+function data_path(name)
+    for dir in [CDFpp_TEST_DATA_PATH, CDFlib_TEST_DATA_PATH, PROJECT_DATA_PATH]
+        path = joinpath(dir, name)
+        isfile(path) && return path
+    end
+    error("Data file not found: $name")
+end
+
 function check_cdf_file(cdf, version, majority, compression)
     @test cdf.version == version
     @test cdf.majority == majority
@@ -25,25 +33,25 @@ function check_variables(cdf)
 end
 
 @testset "Uncompressed cdf file" begin
-    file = joinpath(CDFpp_TEST_DATA_PATH, "a_cdf.cdf")
+    file = data_path("a_cdf.cdf")
     ds = CDFDataset(file)
     check_cdf_file(ds, (3, 9, 0), CDF.Row, CDF.NoCompression)
 end
 
 @testset "CHECK_VARIABLES - Variable structure verification" begin
-    file = joinpath(PROJECT_DATA_PATH, "omni_coho1hr_merged_mag_plasma_20240901_v01.cdf")
+    file = data_path("omni_coho1hr_merged_mag_plasma_20240901_v01.cdf")
     ds = CDFDataset(file)
     @test keys(ds) == ["Epoch", "heliographicLatitude", "heliographicLongitude", "BR", "BT", "BN", "ABS_B", "V", "elevAngle", "azimuthAngle", "N", "T"]
     @test ds["BR"].data[1:3] == Float32[6.7, 6.7, 7.3]
 end
 
 @testset "CHECK_VARIABLES - CDF_CHAR" begin
-    file = joinpath(PROJECT_DATA_PATH, "ge_h0_cpi_00000000_v01.cdf")
+    file = data_path("ge_h0_cpi_00000000_v01.cdf")
     ds = CDFDataset(file)
     @info ds["label_v3c"]
 end
 @testset "CHECK_VARIABLES - Variable structure verification" begin
-    file = joinpath(CDFpp_TEST_DATA_PATH, "a_cdf.cdf")
+    file = data_path("a_cdf.cdf")
     ds = CDFDataset(file)
 
     # Check total number of variables (should be 18 as per C++)