documentation

chrjabs · Jul 11, 2023 · f2a1801 · f2a1801
1 parent ae96ef7
commit f2a1801
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Christoph Jabs <[email protected]>"]
 license = "MIT"
-description = "A rust library for Boolean satisfiabyility (SAT). Contains bindings to SAT solvers, encodings, file parsers and more."
+description = "This library aims to provide implementations of elements commonly used in the development on software in the area of satisfiability solving. The focus of the library is to provide as much ease of use without giving up on performance."
 keywords = ["sat", "satisfiability", "encodings"]
 repository = "https://github.com/chrjabs/rustsat"
 readme = "README.md"

diff --git a/README.md b/README.md
@@ -2,3 +2,9 @@
 
 This library aims to provide implementations of elements commonly used in the development on software in the area of satisfiability solving.
 The focus of the library is to provide as much ease of use without giving up on performance.
+
+## Examples
+
+For example useage refer to the small example tools in the examples directory.
+For a bigger example you can look at this [multi-objective optimization
+solver](https://github.com/chrjabs/pminimal-rs).