From b8326bea437248ab8f622519fd8cc5d56fa8a412 Mon Sep 17 00:00:00 2001
From: Noah Bruns <nbruns@efs.at>
Date: Wed, 10 Apr 2024 15:55:25 +0200
Subject: [PATCH] docs: changelog and readme added

---
 batsat/.gitignore   |  2 ++
 batsat/CHANGELOG.md | 11 +++++++++++
 batsat/README.md    | 18 ++++++++++++++++++
 batsat/src/lib.rs   |  4 ++--
 4 files changed, 33 insertions(+), 2 deletions(-)
 create mode 100644 batsat/.gitignore
 create mode 100644 batsat/CHANGELOG.md
 create mode 100644 batsat/README.md

diff --git a/batsat/.gitignore b/batsat/.gitignore
new file mode 100644
index 00000000..2ebc5ea0
--- /dev/null
+++ b/batsat/.gitignore
@@ -0,0 +1,2 @@
+/target
+/Cargo.lock
\ No newline at end of file
diff --git a/batsat/CHANGELOG.md b/batsat/CHANGELOG.md
new file mode 100644
index 00000000..ef16d198
--- /dev/null
+++ b/batsat/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.2.4] - 2024-04-10
+
+### 🚀 Features
+
+- Implemented batsat api
+
+<!-- generated by git-cliff -->
diff --git a/batsat/README.md b/batsat/README.md
new file mode 100644
index 00000000..846af6d9
--- /dev/null
+++ b/batsat/README.md
@@ -0,0 +1,18 @@
+[![Check & Test](https://github.com/chrjabs/rustsat/actions/workflows/batsat.yml/badge.svg)](https://github.com/chrjabs/rustsat/actions/workflows/batsat.yml)
+[![crates.io](https://img.shields.io/crates/v/rustsat-batsat)](https://crates.io/crates/rustsat-batsat)
+[![docs.rs](https://img.shields.io/docsrs/rustsat-batsat)](https://docs.rs/rustsat-batsat)
+[![License](https://img.shields.io/crates/l/rustsat-batsat)](../LICENSE)
+
+<!-- cargo-rdme start -->
+
+# rustsat-batsat - Interface to the BatSat SAT Solver for RustSAT
+
+The BatSat solver to be used with the [RustSAT](https://github.com/chrjabs/rustsat) library.
+
+## Features
+
+## BatSat Version
+
+The version of BatSat in this crate is Version 0.5.0.
+
+<!-- cargo-rdme end -->
diff --git a/batsat/src/lib.rs b/batsat/src/lib.rs
index 76904587..b4a8b4a6 100644
--- a/batsat/src/lib.rs
+++ b/batsat/src/lib.rs
@@ -1,6 +1,6 @@
-//! # Minisat Solver Interface Without Preprocessing (Core)
+//! # BatSat Solver Interface
 //!
-//! Interface to the [Minisat](https://github.com/niklasso/minisat) incremental
+//! Interface to the [Minisat](https://github.com/c-cube/batsat) incremental
 //! SAT solver.
 
 use batsat::{intmap::AsIndex, lbool, BasicSolver, SolverInterface};