From 55f24614f8255f499d7814b861db24cd7114492a Mon Sep 17 00:00:00 2001
From: Simon Garnier <garnier@njit.edu>
Date: Fri, 10 May 2024 12:11:14 +0200
Subject: [PATCH] Create README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7b102c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# kblimps
+
+<!-- badges: start -->
+[![CRAN status](https://www.r-pkg.org/badges/version/kblimps)](https://CRAN.R-project.org/package=kblimps)
+[![R-CMD-check](https://github.com/swarm-lab/kblimps/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/swarm-lab/kblimps/actions/workflows/R-CMD-check.yaml)
+[![test-coverage](https://github.com/swarm-lab/kblimps/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/swarm-lab/kblimps/actions/workflows/test-coverage.yaml)
+<!-- badges: end -->
+
+The goal of kblimps is to ...
+
+## Installation
+
+You can install the development version of kblimps from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("swarm-lab/kblimps")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(kblimps)
+## basic example code
+```