first version of readme

jefferislab · Jul 15, 2024 · 08be31e · 08be31e
1 parent b53d882
commit 08be31e
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+
+# racq4
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of racq4 is to support analysis of acq4 electrophysiology data in R.
+acq4 is developed in Python; this packages will allow those more familiar with R
+to access key data structures
+
+## Installation
+
+You can install the development version of racq4 from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("pak")
+pak::pkg_install("jefferislab/racq4")
+```