From 5223e36e25154433c6ba7d66561b0240c9ad6bd4 Mon Sep 17 00:00:00 2001
From: Diego Francisco Carvajal Flores <diegofcarvajalf@gmail.com>
Date: Wed, 20 Apr 2022 12:53:24 +0200
Subject: [PATCH] Update README

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 98edad8..4302550 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 # WoT+IL OPC UA to Fiware
 
-## SUMMARY
+Component that generates interoperability between an OPC UA server and FIWARE Orion LD Context Broker, using the SHOP4CF data model.
+
+## Installing
+
+Clone the respository 
+
+Execute  ``npm install`` to download all needed extra modules
+
+## Running
+
+Execute ``ts-node upmclient.ts`` to run the component
+
+## Docker
+
+Execute ``docker build -t imagename .`` to build the image
+
+Execute ``docker run -d --env-file environment.env imagename`` to create a container using the crated image
+
+### Docker environmnet variables
+
+To configure the OPC UA server variables check the [ENV](./environment.env) file
+
+## Docker offline image generation/import
+
+To donwnload a docker image as a file execute `` docker save -o targetfilename.tar imagename ``
+
+To upload docker image from file execute `` docker load --input imagename.tar ``
\ No newline at end of file
-- 
GitLab