README and CHANGELOG

ITISFoundation · Aug 4, 2023 · daec0ad · daec0ad
1 parent 3352fe8
commit daec0ad
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## [1.0.0] - 2022-02-08
-- First version
+## [1.0.0] - 2023-08-04
+- First version for testing in master
 
 
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
 ## Voilà Viewer
 Source code of the correspondng o²S²PARC Service that takes as input a Jupyter Notebook and it shows it using Jupyter [Voilà](https://github.com/voila-dashboards/voila)
+
+## How it works
+The Service waits for a `voila.ipynb` file in input_1, when it is found, in renders it with voila:
+
+
+![Voila_Viewer_v1](https://github.com/ITISFoundation/voila-viewer/assets/18575092/73d43e27-71d8-4733-bf20-32262a2e9824)
+
+## How to test
+
+### Locally
+
+```
+make build run-local # Then visit 127.0.0.1:8888 in your browser
+```
+A `voila.ipynb` has to be `added to validation/inputs/input_1`
+### In a local o²S²PARC deployment
+
+```
+make build publish-local
+```
+
+### In o²S²PARC
+Use the "Voila-viewer Example" template in master.