From e121e012776f3e15acc5d0dd03e49efc60e175c9 Mon Sep 17 00:00:00 2001
From: Giancarlo Rocha <giancarloiff@gmail.com>
Date: Sun, 10 Sep 2023 12:10:03 -0300
Subject: [PATCH] chore: update readme

---
 README.md | 37 +++++++++++++++++++++++++++++++------
 1 file changed, 31 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 40c55a9..700ca54 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,35 @@
-Term
-Um termo pode ser qualquer uma das seguintes estruturas:
+# rinha-de-compiler
 
-- [ ] Let
-- [ ] Var
-- [ ] Function
-- [ ] Call
+![samples run](https://github.com/giancarlopro/rinha-de-compiler/actions/workflows/run_tinha_samples/badge.svg)
+
+Esse projeto é um interpretador criado para ser submetido a [rinha de compilers](https://github.com/aripiprazole/rinha-de-compiler).
+
+## Como executar
+
+Basta compilar o projeto e executar o binário gerado passando o caminho para o arquivo que deseja executar.
+
+```bash
+make
+./build/interpreter <path-to-file>
+```
+
+Ou usando o docker
+
+```bash
+docker build . -f Dockerfile -t rinha-c-interpreter
+
+docker run \
+    --rm \
+    -v <path-to-file>:/var/rinha/source.rinha.json \
+    rinha-c-interpreter
+```
+
+## CheckList de Funcionalidades
+
+- [x] Let
+- [x] Var
+- [x] Call
+- [x] Function
 - [x] If
 - [x] Binary
 - [x] Int