From b1621819caa0783bd4297d712ea83241ebf201e3 Mon Sep 17 00:00:00 2001
From: LordMathis <matus@namesny.com>
Date: Sun, 17 Mar 2024 16:18:42 +0100
Subject: [PATCH] Update README

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 38 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 4c7721e..beff362 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,40 @@
 # CUDANet
 
-requirements:
-- CUDA
-- Google Test 
\ No newline at end of file
+:warning: Work in progress
+
+Convolutional Neural Network inference library running on CUDA.
+
+## Features
+
+- [x] Input layer
+- [x] Dense (fully-connected) layer
+- [x] Conv2d layer
+- [ ] Max pooling
+- [ ] Average pooling
+- [ ] Concat layer
+- [x] Sigmoid activation
+- [x] ReLU activation
+- [ ] Softmax activation
+- [ ] Load weights from file 
+
+## Usage
+
+**requirements**
+- [cmake](https://cmake.org/)
+- [CUDA](https://developer.nvidia.com/cuda-downloads)
+- [Google Test](https://github.com/google/googletest) (for testing only)
+
+**build and test**
+
+```sh
+mkdir build
+cd build
+cmake -S ..
+make
+```
+
+Run tests
+
+```sh
+./test/test_main
+```
\ No newline at end of file