From 3a341f952764d97a29e58e1d7e6028f1302dfedd Mon Sep 17 00:00:00 2001
From: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Date: Tue, 12 Sep 2023 13:52:43 -0700
Subject: [PATCH] Improve readme header (#5432)

* Improve readme header

* Update README.md

* Update README.md

* Update README.md
---
 README.md                    | 71 +++++++++++++++---------------------
 images/openbb-logo-dark.svg  | 17 +++++++++
 images/openbb-logo-light.svg | 17 +++++++++
 3 files changed, 63 insertions(+), 42 deletions(-)
 create mode 100644 images/openbb-logo-dark.svg
 create mode 100644 images/openbb-logo-light.svg

diff --git a/README.md b/README.md
index 8c9170ac86c..d4618e4c529 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,44 @@
-<!-- PROJECT SHIELDS -->
-<!--
-*** I'm using markdown "reference style" links for readability.
-*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
-*** See the bottom of this document for the declaration of the reference variables
-*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
-*** https://www.markdownguide.org/basic-syntax/#reference-style-links
--->
-
-[![Stargazers][stars-shield]][stars-url]
-[![Forks][forks-shield]][forks-url]
-[![Contributors][contributors-shield]][contributors-url]
-[![MIT License][license-shield]][license-url]
-
-[![Issues][issues-shield]][issues-url]
-[![Bugs Open][bugs-open-shield]][bugs-open-url]
-[![Bugs Closed][bugs-closed-shield]][bugs-closed-url]
-
-[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/OpenBB-finance/OpenBBTerminal/main)](https://www.tickgit.com/browse?repo=github.com/OpenBB-finance/OpenBBTerminal&branch=main)
-
-![Discord Shield](https://discordapp.com/api/guilds/831165782750789672/widget.png?style=shield)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/openbb_finance.svg?style=social&label=Follow%20%40openbb_finance)](https://twitter.com/openbb_finance)
-
-[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBBTerminal)
-
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/OpenBB-finance/OpenBBTerminal)
-
-<!-- PROJECT LOGO -->
-
-| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
-|:--:|
-| [![openbb.jpg](/images/openbb_gradient.png)](https://openbb.co) |
-| Check our website at [openbb.co](https://openbb.co) |
-
+<br />
+<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/images/openbb-logo-dark.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600">
+<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/images/openbb-logo-light.svg?raw=true#gh-dark-mode-only" alt="OpenBB Terminal logo" width="600">
+<br />
 <br />
 
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/openbb_finance.svg?style=social&label=Follow%20%40openbb_finance)](https://twitter.com/openbb_finance)
+[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases)
+![Discord Shield](https://discordapp.com/api/guilds/831165782750789672/widget.png?style=shield)
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBBTerminal)
+<a href="https://codespaces.new/OpenBB-finance/OpenBBTerminal">
+  <img src="https://github.com/codespaces/badge.svg" height="20" />
+</a>
+
+OpenBB is committed to building the future of investment research by focusing on an open-source infrastructure accessible to everyone, everywhere.
+
 <p align="center">
-  <h3 align="center">OpenBB Terminal 🚀</h3>
-  <h4 align="center">Documentation can be found at: https://openbb.co/docs </h4>
-  <p align="center">Click on the GIF below for a DEMO of the terminal.</p>
 
   <p align="center">
      <a href="https://www.youtube.com/watch?v=fqGPK8OVHLk" rel="OpenBB Terminal Demo">
         <img src="images/openbb_terminal_illustration.gif" alt="OpenBB Terminal Illustration" width="100%"/>
      </a>
+     <p align="center">Click on the GIF above for a DEMO</p>
   </p>
 
   <p align="center">
-    <a href="https://docs.openbb.co/terminal/installation"><strong>≪  GETTING STARTED</strong></a>
-    &nbsp · &nbsp <a href="https://github.com/OpenBB-finance/OpenBBTerminal/tree/master/CONTRIBUTING.md"><strong>CONTRIBUTING</strong></a> &nbsp · &nbsp
+    <a href="https://docs.openbb.co/terminal/installation">
+      <strong>≪  GETTING STARTED</strong>
+    </a>
+    &nbsp · &nbsp
+    <a href="https://github.com/OpenBB-finance/OpenBBTerminal/tree/master/CONTRIBUTING.md">
+      <strong>CONTRIBUTING</strong>
+    </a>
+    &nbsp · &nbsp
+    <a href="https://openbb.co/docs">
+      <strong>DOCUMENTATION</strong>
+    </a>
+    &nbsp · &nbsp
     <a href="https://docs.openbb.co/terminal">
-    <strong>SEE FEATURES »</strong></a>
+      <strong>SEE FEATURES »</strong>
+    </a>
   </p>
 </p>
 
diff --git a/images/openbb-logo-dark.svg b/images/openbb-logo-dark.svg
new file mode 100644
index 00000000000..75bcef259e1
--- /dev/null
+++ b/images/openbb-logo-dark.svg
@@ -0,0 +1,17 @@
+<svg width="444" height="19" viewBox="0 0 444 19" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M125.279 0.891602V2.01694V3.13959V4.26225V5.38758V6.51292V7.63557V8.76091V9.88357V11.0089V12.1316V13.2569V14.3796L124.152 13.2569L123.028 12.1316L121.901 11.0089L120.777 9.88357L119.65 8.76091L118.523 7.63557L117.399 6.51292L116.273 5.38758L115.148 4.26225L114.022 3.13959L112.898 2.01694L111.771 0.891602H110.647H109.52V2.01694V3.13959V4.26225V5.38758V6.51292V7.63557V8.76091V9.88357V11.0089V12.1316V13.2569V14.3796V15.5049V16.6302V17.7529V18.8755H110.647H111.771V17.7529V16.6302V15.5049V14.3796V13.2569V12.1316V11.0089V9.88357V8.76091V7.63557V6.51292V5.38758V4.26225L112.898 5.38758L114.022 6.51292L115.148 7.63557L116.273 8.76091L117.399 9.88357L118.523 11.0089L119.65 12.1316L120.777 13.2569L121.901 14.3796L123.028 15.5049L124.152 16.6302L125.279 17.7529L126.403 18.8755H127.529V17.7529V16.6302V15.5049V14.3796V13.2569V12.1316V11.0089V9.88357V8.76091V7.63557V6.51292V5.38758V4.26225V3.13959V2.01694V0.891602H126.403H125.279Z" fill="black"/>
+<path d="M161.517 7.63557H159.266V0.891602H145.761V18.8782H163.773V7.62486H161.522L161.517 7.63557ZM148.012 6.50488V3.1396H157.015V7.63557H148.012V6.50488ZM161.517 11.0009V16.6275H148.012V9.88625H161.517V11.0009Z" fill="black"/>
+<path d="M198.866 7.63557H195.491V0.891602H181.983V18.8782H199.99V7.62486L198.866 7.63557ZM184.234 6.50488V3.1396H193.24V7.63557H184.234V6.50488ZM197.742 11.0009V16.6275H184.234V9.88625H197.742V11.0009Z" fill="black"/>
+<path d="M89.1901 0.891602H89.1847H88.0633H86.9392H85.8125H84.6884H83.5616H82.4376H81.3108H80.1867H79.06H77.9359H76.8091H75.685H74.5583H73.4315V2.01694V3.13959V4.26225V5.38758V6.51292V7.63557V8.76091V9.88357V11.0089V12.1316V13.2569V14.3796V15.5049V16.6302V17.7529V18.8755H74.5583H75.685H76.8091H77.9359H79.06H80.1867H81.3108H82.4376H83.5616H84.6884H85.8125H86.9392H88.0633H89.1847H89.1901H90.3115H91.4355V17.7529V16.6302H90.3115H89.1901H89.1847H88.0633H86.9392H85.8125H84.6884H83.5616H82.4376H81.3108H80.1867H79.06H77.9359H76.8091H75.685V15.5049V14.3796V13.2569V12.1316H76.8091H77.9359H79.06H80.1867H81.3108H82.4376H83.5616H84.6884H85.8071H85.8125H86.9339H88.0579H89.1847V11.0089V9.88357H88.0579H86.9339H85.8125H85.8071H84.6884H83.5616H82.4376H81.3108H80.1867H79.06H77.9359H76.8091H75.685V8.76091V7.63557V6.51292V5.38758V4.26225V3.13959H76.8091H77.9359H79.06H80.1867H81.3108H82.4376H83.5616H84.6884H85.8125H86.9392H88.0633H89.1847H89.1901H90.3115H91.4355V2.01694V0.891602H90.3115H89.1901Z" fill="black"/>
+<path d="M16.6851 0.891602H0.929199V18.8782H18.9386V0.891602H16.6878H16.6851ZM16.6851 4.26493V16.6302H3.17736V3.1396H16.6851V4.26493Z" fill="black"/>
+<path d="M52.9584 0.891323H37.2025V18.8779H39.4534V12.1313H55.2092V0.87793H52.9584V0.891323ZM52.9584 4.26466V9.89133H39.4534V3.13932H52.9584V4.26466Z" fill="black"/>
+<path d="M382.696 0.87793V2.00091V3.12122V4.24152V5.3645V6.48749V7.60779V8.73077V9.85108V10.9741V12.0944V13.2173V14.3377L381.572 13.2173L380.45 12.0944L379.326 10.9741L378.204 9.85108L377.08 8.73077L375.955 7.60779L374.834 6.48749L373.709 5.3645L372.588 4.24152L371.463 3.12122L370.342 2.00091L369.217 0.87793H368.095H366.971V2.00091V3.12122V4.24152V5.3645V6.48749V7.60779V8.73077V9.85108V10.9741V12.0944V13.2173V14.3377V15.4606V16.5836V17.7039V18.8242H368.095H369.217V17.7039V16.5836V15.4606V14.3377V13.2173V12.0944V10.9741V9.85108V8.73077V7.60779V6.48749V5.3645V4.24152L370.342 5.3645L371.463 6.48749L372.588 7.60779L373.709 8.73077L374.834 9.85108L375.955 10.9741L377.08 12.0944L378.204 13.2173L379.326 14.3377L380.45 15.4606L381.572 16.5836L382.696 17.7039L383.818 18.8242H384.942V17.7039V16.5836V15.4606V14.3377V13.2173V12.0944V10.9741V9.85108V8.73077V7.60779V6.48749V5.3645V4.24152V3.12122V2.00091V0.87793H383.818H382.696Z" fill="black"/>
+<path d="M322.41 18.8301V0.87793H324.691L331.916 8.17812L338.075 0.87793H340.356V18.8301H338.075V4.37594L333.056 10.4594H330.775L324.691 4.37594V18.8301H322.41Z" fill="black"/>
+<path d="M277.828 0.87793H277.823H276.704H275.582H274.458H273.336H272.212H271.09H269.966H268.844H267.719H266.598H265.473H264.352H263.227H262.103V2.00091V3.12122V4.24152V5.3645V6.48749V7.60779V8.73077V9.85108V10.9741V12.0944V13.2173V14.3377V15.4606V16.5836V17.7039V18.8242H263.227H264.352H265.473H266.598H267.719H268.844H269.966H271.09H272.212H273.336H274.458H275.582H276.704H277.823H277.828H278.947H280.069V17.7039V16.5836H278.947H277.828H277.823H276.704H275.582H274.458H273.336H272.212H271.09H269.966H268.844H267.719H266.598H265.473H264.352V15.4606V14.3377V13.2173V12.0944H265.473H266.598H267.719H268.844H269.966H271.09H272.212H273.336H274.452H274.458H275.577H276.698H277.823V10.9741V9.85108H276.698H275.577H274.458H274.452H273.336H272.212H271.09H269.966H268.844H267.719H266.598H265.473H264.352V8.73077V7.60779V6.48749V5.3645V4.24152V3.12122H265.473H266.598H267.719H268.844H269.966H271.09H272.212H273.336H274.458H275.582H276.704H277.823H277.828H278.947H280.069V2.00091V0.87793H278.947H277.828Z" fill="black"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M231.99 0.87793L231.99 3.15924L239.822 3.15924V18.8242H242.104V3.15924L249.936 3.15924V0.87793L242.104 0.87793H239.822L231.99 0.87793Z" fill="black"/>
+<rect x="352.523" y="0.87793" width="2.28129" height="17.9463" fill="black"/>
+<path d="M427.281 0.87793H429.562V16.8471H443.25V18.8242H427.281V0.87793Z" fill="black"/>
+<path d="M307.994 18.8779L303.881 11.7958H306.13L310.243 18.8779H307.994Z" fill="black"/>
+<path d="M307.989 0.891322H292.236V18.8757H294.486V12.1299H310.24V0.87793H307.989V0.891322ZM307.989 9.89022H294.486V3.13904H307.989V9.89022Z" fill="black"/>
+<path d="M412.863 0.891322H397.109V18.8757H399.36V12.1299H412.863V18.8757H415.113V0.87793H412.863V0.891322ZM412.863 9.89022H399.36V3.13904H412.863V9.89022Z" fill="black"/>
+</svg>
diff --git a/images/openbb-logo-light.svg b/images/openbb-logo-light.svg
new file mode 100644
index 00000000000..f9c341f7428
--- /dev/null
+++ b/images/openbb-logo-light.svg
@@ -0,0 +1,17 @@
+<svg width="443" height="18" viewBox="0 0 443 18" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M124.349 0.0136719V1.13901V2.26166V3.38432V4.50965V5.63499V6.75765V7.88298V9.00564V10.131V11.2536V12.379V13.5016L123.223 12.379L122.099 11.2536L120.972 10.131L119.848 9.00564L118.721 7.88298L117.594 6.75765L116.47 5.63499L115.343 4.50965L114.219 3.38432L113.093 2.26166L111.968 1.13901L110.842 0.0136719H109.718H108.591V1.13901V2.26166V3.38432V4.50965V5.63499V6.75765V7.88298V9.00564V10.131V11.2536V12.379V13.5016V14.627V15.7523V16.8749V17.9976H109.718H110.842V16.8749V15.7523V14.627V13.5016V12.379V11.2536V10.131V9.00564V7.88298V6.75765V5.63499V4.50965V3.38432L111.968 4.50965L113.093 5.63499L114.219 6.75765L115.343 7.88298L116.47 9.00564L117.594 10.131L118.721 11.2536L119.848 12.379L120.972 13.5016L122.099 14.627L123.223 15.7523L124.349 16.8749L125.473 17.9976H126.6V16.8749V15.7523V14.627V13.5016V12.379V11.2536V10.131V9.00564V7.88298V6.75765V5.63499V4.50965V3.38432V2.26166V1.13901V0.0136719H125.473H124.349Z" fill="white"/>
+<path d="M160.588 6.75764H158.337V0.0136719H144.832V18.0003H162.844V6.74693H160.593L160.588 6.75764ZM147.083 5.62695V2.26167H156.086V6.75764H147.083V5.62695ZM160.588 10.1229V15.7496H147.083V9.00832H160.588V10.1229Z" fill="white"/>
+<path d="M197.937 6.75764H194.562V0.0136719H181.054V18.0003H199.061V6.74693L197.937 6.75764ZM183.305 5.62695V2.26167H192.311V6.75764H183.305V5.62695ZM196.813 10.1229V15.7496H183.305V9.00832H196.813V10.1229Z" fill="white"/>
+<path d="M88.2609 0.0136719H88.2555H87.1341H86.01H84.8833H83.7592H82.6324H81.5084H80.3816H79.2575H78.1308H77.0067H75.8799H74.7558H73.6291H72.5023V1.13901V2.26166V3.38432V4.50965V5.63499V6.75765V7.88298V9.00564V10.131V11.2536V12.379V13.5016V14.627V15.7523V16.8749V17.9976H73.6291H74.7558H75.8799H77.0067H78.1308H79.2575H80.3816H81.5084H82.6324H83.7592H84.8833H86.01H87.1341H88.2555H88.2609H89.3823H90.5063V16.8749V15.7523H89.3823H88.2609H88.2555H87.1341H86.01H84.8833H83.7592H82.6324H81.5084H80.3816H79.2575H78.1308H77.0067H75.8799H74.7558V14.627V13.5016V12.379V11.2536H75.8799H77.0067H78.1308H79.2575H80.3816H81.5084H82.6324H83.7592H84.8779H84.8833H86.0047H87.1287H88.2555V10.131V9.00564H87.1287H86.0047H84.8833H84.8779H83.7592H82.6324H81.5084H80.3816H79.2575H78.1308H77.0067H75.8799H74.7558V7.88298V6.75765V5.63499V4.50965V3.38432V2.26166H75.8799H77.0067H78.1308H79.2575H80.3816H81.5084H82.6324H83.7592H84.8833H86.01H87.1341H88.2555H88.2609H89.3823H90.5063V1.13901V0.0136719H89.3823H88.2609Z" fill="white"/>
+<path d="M15.7559 0.0136719H0V18.0003H18.0094V0.0136719H15.7586H15.7559ZM15.7559 3.387V15.7523H2.24816V2.26167H15.7559V3.387Z" fill="white"/>
+<path d="M52.0292 0.0133936H36.2733V18H38.5242V11.2534H54.28V0H52.0292V0.0133936ZM52.0292 3.38673V9.0134H38.5242V2.26139H52.0292V3.38673Z" fill="white"/>
+<path d="M381.767 0V1.12298V2.24329V3.36359V4.48657V5.60956V6.72986V7.85284V8.97315V10.0961V11.2164V12.3394V13.4597L380.643 12.3394L379.521 11.2164L378.397 10.0961L377.275 8.97315L376.151 7.85284L375.026 6.72986L373.905 5.60956L372.78 4.48657L371.658 3.36359L370.534 2.24329L369.412 1.12298L368.288 0H367.166H366.042V1.12298V2.24329V3.36359V4.48657V5.60956V6.72986V7.85284V8.97315V10.0961V11.2164V12.3394V13.4597V14.5827V15.7057V16.826V17.9463H367.166H368.288V16.826V15.7057V14.5827V13.4597V12.3394V11.2164V10.0961V8.97315V7.85284V6.72986V5.60956V4.48657V3.36359L369.412 4.48657L370.534 5.60956L371.658 6.72986L372.78 7.85284L373.905 8.97315L375.026 10.0961L376.151 11.2164L377.275 12.3394L378.397 13.4597L379.521 14.5827L380.643 15.7057L381.767 16.826L382.889 17.9463H384.013V16.826V15.7057V14.5827V13.4597V12.3394V11.2164V10.0961V8.97315V7.85284V6.72986V5.60956V4.48657V3.36359V2.24329V1.12298V0H382.889H381.767Z" fill="white"/>
+<path d="M321.481 17.9522V0H323.762L330.986 7.30019L337.146 0H339.427V17.9522H337.146V3.49801L332.127 9.5815H329.846L323.762 3.49801V17.9522H321.481Z" fill="white"/>
+<path d="M276.899 0H276.894H275.775H274.653H273.529H272.407H271.282H270.161H269.036H267.915H266.79H265.669H264.544H263.422H262.298H261.174V1.12298V2.24329V3.36359V4.48657V5.60956V6.72986V7.85284V8.97315V10.0961V11.2164V12.3394V13.4597V14.5827V15.7057V16.826V17.9463H262.298H263.422H264.544H265.669H266.79H267.915H269.036H270.161H271.282H272.407H273.529H274.653H275.775H276.894H276.899H278.018H279.14V16.826V15.7057H278.018H276.899H276.894H275.775H274.653H273.529H272.407H271.282H270.161H269.036H267.915H266.79H265.669H264.544H263.422V14.5827V13.4597V12.3394V11.2164H264.544H265.669H266.79H267.915H269.036H270.161H271.282H272.407H273.523H273.529H274.648H275.769H276.894V10.0961V8.97315H275.769H274.648H273.529H273.523H272.407H271.282H270.161H269.036H267.915H266.79H265.669H264.544H263.422V7.85284V6.72986V5.60956V4.48657V3.36359V2.24329H264.544H265.669H266.79H267.915H269.036H270.161H271.282H272.407H273.529H274.653H275.775H276.894H276.899H278.018H279.14V1.12298V0H278.018H276.899Z" fill="white"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M231.061 -6.4373e-05L231.061 2.28124L238.893 2.28124V17.9462H241.175V2.28124L249.007 2.28124V-6.51575e-05L241.175 -6.4463e-05H238.893L231.061 -6.4373e-05Z" fill="white"/>
+<rect x="351.594" width="2.28129" height="17.9463" fill="white"/>
+<path d="M426.351 0H428.633V15.9692H442.32V17.9463H426.351V0Z" fill="white"/>
+<path d="M307.065 18L302.952 10.9179H305.201L309.314 18H307.065Z" fill="white"/>
+<path d="M307.06 0.0133919H291.307V17.9978H293.557V11.252H309.311V0H307.06V0.0133919ZM307.06 9.01229H293.557V2.26111H307.06V9.01229Z" fill="white"/>
+<path d="M411.934 0.0133919H396.18V17.9978H398.43V11.252H411.934V17.9978H414.184V0H411.934V0.0133919ZM411.934 9.01229H398.43V2.26111H411.934V9.01229Z" fill="white"/>
+</svg>