Improve documentation and add tests

[zheylmun]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.13%. Comparing base (e156802) to head (912c015).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #3   +/-   ##
=======================================
  Coverage   95.13%   95.13%           
=======================================
  Files           8        8           
  Lines         576      576           
=======================================
  Hits          548      548           
  Misses         28       28           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Copilot]

PR Overview

This PR improves the project documentation and enhances test coverage while updating CI configuration to use the stable Rust toolchain.

• Updates README badges and refines the project description.
• Adjusts CI workflow configuration to use the stable Rust toolchain.
• Expands tests in src/lib.rs to verify the loading of survey files.

Reviewed Changes

File	Description
README.md	Adds badges and updates text to clarify project goals.
.github/workflows/ci.yml	Switches from nightly to stable toolchain for CI tasks.
src/lib.rs	Updates tests to load survey files after project reading.
src/project/mod.rs	Adds minor documentation details for the datum type.

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

.github/workflows/ci.yml:24

• Switching from the nightly to the stable toolchain while still specifying components (like rustc-dev) may cause issues if these components are unavailable on the stable channel. Please verify that all required components are supported on the stable toolchain.

- uses: dtolnay/rust-toolchain@stable

src/lib.rs:25

• [nitpick] The variable name 'unloaded_project' might be misleading since the project is subsequently loaded with survey files; consider renaming it to 'project' for clarity.

let unloaded_project = Project::read(&sample_path).unwrap();

[zheylmun]

🤷🏻 Why not see what CoPilot has to say