License and README files updated

dinlink · May 2, 2021 · 76b9194 · 76b9194
1 parent b69cde7
commit 76b9194
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 dinlink
+Copyright (c) 2021 Abraham Vivas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1 +1,15 @@
-# inPipeAxialTurbineDesign
+# Dimensionless in-pipe axial pico-hydraulic turbine design
+This repository contains the companion code to a novel approach for the design of in-pipe pico-hydraulic turbine design. It contains the literate code of the design algorithm applied to a design example.
+
+The included ipython notebook was intended to be uploaded to Google Drive and used with Google Colab extension, but it can be easily adapted to be used standalone.
+
+A generated dimensionless design chart and the corresponding designed turbine is shown in figure 1 and 2.
+
+![alt text][exDDC]
+Figure 1. Example dimensionless design chart generated using the algorithm.
+
+![alt text][exT]
+Figure 2. Example designed turbine
+
+[exDDC]:https://github.com/dinlink/inPipeAxialTurbineDesign/tree/master/img/exDDC.png
+[exT]:https://github.com/dinlink/inPipeAxialTurbineDesign/tree/master/img/exT.png
diff --git a/img/exDDC.png b/img/exDDC.png
diff --git a/img/exT.png b/img/exT.png