1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2805e09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# `notas`
+
+> Un sencillo script para tomar notas o llevar un diario en texto plano.
+
+Al ejecutar `notas` el script genera archivos Markdown organizados de forma
+cronológica: una archivo por cada mes del año y dentro de ellos subsecciones
+para cada día.
+
+Es posible configurar el directorio en el cual vamos a guardar nuestras notas
+modificando la variable `notas_dir` en el script.
+
+Puedes utilizar comandos como `grep` para buscar notas anteriores en todo tu
+directorio y sincronizar tus notas con herramientas como Syncthing, Nextcloud
+o rsync.
+
+
+## Cómo instalar?
+
+Clona este repositorio en tu computadora:
+
+```
+git clone https://git.texto-plano.xyz/santisoler/notas
+```
+
+Navega a la carpeta decargada:
+
+```
+cd notas
+```
+
+Y copia el script `notas` en un directorio que se encuentre en tu variable
+`PATH`.
+
+> Puedes comprobar qué directorios se encuentran en tu variable `PATH`
+> ejecutando `echo $PATH`.
+
+Por ejemplo, instalando el script para tu usuario:
+
+```
+cp notas ~/.local/bin
+```
+
+O bien, para todes les usuaries del sistema (requiere permisos de
+superusuario):
+
+```
+cp notas /usr/local/bin
+```
+
+
+## Licencia
+
+Este repositorio contiene Software Libre: puedes redistribuirlo y/o modificarlo
+dentro de los términos de la licencia **BSD 3-clause**. Una copia de esta
+licencia se encuentra provista en el archivo LICENSE.txt.