From 5d30d15867f87f75b84c9fcc82b799a11997090b Mon Sep 17 00:00:00 2001
From: Joel Einbinder <joel.einbinder@gmail.com>
Date: Tue, 31 Oct 2023 01:39:54 -0400
Subject: [PATCH] add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..96c3f402
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Snail
+
+I've been using snail as my only terminal for over a year, but I would not recommend other people use it as part of their critical infrastructure yet. The apis might change before the 1.0 release and I can't garuantee it won't eat your data. That being said, I welcome feedback from the brave!
+
+## Install and run from source
+Install dependencies
+```sh
+npm install
+```
+Running snail
+```sh
+npm start
+```