Skip to content

Commit

Permalink
add a readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelEinbinder committed Oct 31, 2023
1 parent 637ef1a commit 5d30d15
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 5d30d15

Please sign in to comment.