improved readme's

JeroenGar · Feb 19, 2024 · 6d369fa · 6d369fa
1 parent cbddfcc
commit 6d369fa
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Jagua-rs ![workflow](https://github.com/JeroenGar/jagua-rs/actions/workflows/rust.yml/badge.svg)
-**An open-source collision detection engine for 2D irregular cutting and packing problems writen in Rust 🦀.**
+**An open-source collision detection engine for 2D irregular cutting and packing problems written in Rust 🦀.**
 
 <img src="assets/jaguars_logo.svg" width="50%" alt="Jaguars logo">
 

diff --git a/jaguars/README.md b/jaguars/README.md
@@ -23,7 +23,7 @@ In summary, `jaguars` can be used to model 2D irregular C\&P problems
 
 It cannot be used on its own, but is designed to be used in combination with an overlying optimization algorithm to solve 2D irregular cutting and packing problems.
 
-## Docs
+## Documentation
 
 The code is documented using rustdoc. 
 The docs can be build using `cargo doc --open` from the root of the repository.