From 5e7240fbe867e1dd3008e737995cda45d63c5083 Mon Sep 17 00:00:00 2001
From: jvech <jmvalenciae@unal.edu.co>
Date: Wed, 18 Oct 2023 22:14:52 -0500
Subject: doc: README added

Installation and uninstallation rules must be added on Makefile
---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e11a0b9..9baa0ac 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
-# A neural network built from scratch
+# ML
 
+A simple neural network maker developed to train json data
+
+## Requirements
+
+* [openblas](https://www.openblas.net)
+* [json-c](https://github.com/json-c/json-c)
+
+## Installation
+
+```
+git clone https://git.juanvalencia.xyz/ml
+cd ml
+sudo make install
+```
+
+## Uninstall
+
+```
+sudo make uninstall
+```
+
+## Usage
+```
+Usage: ml train [Options] JSON_FILE
+   or: ml predict [-o FILE] FILE
+Train and predict json data
+
+Options:
+  -h, --help               Show this message
+  -a, --alpha=ALPHA        Learning rate (only works with train)
+  -e, --epochs=EPOCHS      Epochs to train the model (only works with train)
+  -o, --output=FILE        Output file (only works with predict)
+
+Examples:
+  $ ml train -e 150 -a 1e-4 housing.json
+  $ ml predict housing.json -o predictions.json
+```
-- 
cgit v1.2.3-70-g09d2