From 707a99b939e3ba886606edc96ee9ef48f81d0f33 Mon Sep 17 00:00:00 2001
From: Jim Richter <jim-x@web.de>
Date: Sun, 4 Jul 2021 16:17:22 +0200
Subject: [PATCH] feat: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0bd7c8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# jim-fx's Dotfiles
+
+## Features
+- [ZSH](https://www.zsh.org/) + [oh-my-zsh](https://ohmyz.sh/) + [p10k](https://github.com/romkatv/powerlevel10k)
+- [asdf version manager](https://asdf-vm.com/#/)
+- [pre-configured](./configs/init.vim) [neovim](https://neovim.io/)
+- 1 line installation
+
+## Installation
+
+*Unsupervised*
+
+```bash
+sh -c "$(curl -L setup.jim-fx.com)"
+```
+
+*Manual*
+
+```bash
+git clone git@github.com:jim-fx/.dotfiles.git ~/.dotfiles
+chmod +x ~/.dotfiles/setup.sh
+~/.dotfiles/setup.sh
+```
+
+## Testing
+
+If you want to test the script before you can run the provided docker image.
+
+```bash
+docker build . -t jim-fx/dotfiles
+docker run -it jim-fx/dotfiles
+```