Test readme images

README.md

@@ -1,11 +1,22 @@
-# Speckle Automate function template - Python
+# Introduction
+
+**Urban Wind Simulation** is a speckle automate function that aims to solve wind comfort levels on urban level by using computational fluid dynamics with OpenFOAM 9. The base libraries behind it is [archaea-simulation](https://pypi.org/project/archaea-simulation/) and [archaea](https://pypi.org/project/archaea/) which include interfaces to convert given geometries into CFD scenarios.
+
+![CFD Sample Result](/img/sample_result.png)
+
+## Inputs
+
+1. Wind Direction
+
+Direction of the wind represents with meteorological angles designated by δ, increase clockwise from the north (y) axis. Math angles, designated by α, increase counterclockwise from the east (x) axis.
+
+![Math & Meteo Angles](/img/math_meteo_angles.png)
+
+2. Wind Speed
 
 
-This is a template repository for a Speckle Automate functions written in python
-using the [specklepy](https://pypi.org/project/specklepy/) SDK to interact with Speckle data.
 
-This template contains the full scaffolding required to publish a function to the automate environment.
-Also has some sane defaults for a development environment setups.
+3. Number of CPUs
 
 ## Getting started