Update README.md

Author: Andrea Palazzi

README.md

@@ -1,2 +1,32 @@
 # ConvLSTM_pytorch
-Implementation of Convolutional LSTM in PyTorch.
+**[This](https://github.com/ndrplz/ConvLSTM_pytorch/blob/master/convlstm.py)** file **implements of Convolutional LSTM in PyTorch** made by [me](https://github.com/ndrplz) and [DavideA](https://github.com/DavideA).
+
+We started from [this](https://github.com/rogertrullo/pytorch_convlstm/blob/master/conv_lstm.py) implementation and heavily refactored it add added features to match our needs.
+
+### How to Use
+The `ConvLSTM` module derives from `nn.Module` so it can be used as any other PyTorch module.
+
+The ConvLSTM class supports an arbitrary number of layers. In this case, it can be specified the hidden dimension (that is, the number of channels) and the kernel size of each layer. In the case more layers are present but a single value is provided, this is replicated for all the layers. For example, in the following snippet each of the three layers has a different hidden dimension but the same kernel size.
+
+Example usage:
+```
+model = ConvLSTM(input_size=(height, width),
+                 input_dim=channels,
+                 hidden_dim=[64, 64, 128],
+                 kernel_size=(3, 3),
+                 num_layers=3,
+                 batch_first=True
+                 bias=True,
+                 return_all_layers=False)
+```
+
+### TODO (in progress...)
+- Comment code
+- Add docs
+- Add example usage on a toy problem
+- Implement stateful mechanism
+- ...
+
+### Disclaimer
+
+This is still a work in progress and is far from being perfect: if you find any bug please don't hesitate to open an issue.