Added docs

ulises-jeremias · Mar 31, 2023 · d6ec3f8 · d6ec3f8
1 parent dcbd5f6
commit d6ec3f8
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/common/README.md b/common/README.md
@@ -1,3 +1,22 @@
 # Dotfiles
 
 This repository contains my dotfiles generated with [dotfiles generator](https://github.com/ulises-jeremias/dotfiles)!
+
+## Usage
+
+### Requirements
+
+In order to install the dotfiles you need to have the `dots` command installed. You can install it with the following command:
+
+```bash
+git clone https://github.com/ulises-jeremias/dotfiles.git /tmp/dotfiles
+cd /tmp/dotfiles
+sudo ./install
+```
+
+### Installation
+
+```sh
+cd <path-to-this-repository>
+./install
+```