From 737c856c1c9c291dd4a334ecdc23276c9c520871 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 15:02:41 +0100 Subject: [PATCH 1/8] main readme --- README.md | 55 ++++++++++--------------------------------------------- 1 file changed, 10 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index b6137bb262f6..6c01d0555b05 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ However, we are committed to continuing our mission to democratize investment re To achieve that, we are working on a new CLI tool built on top of the OpenBB Platform that will soon be available to everyone for free. +[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases) ---
OpenBB Terminal logo @@ -16,7 +17,6 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla
[![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) @@ -25,39 +25,11 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla Open In Colab +[![PyPI](https://img.shields.io/pypi/v/openbb?color=blue&label=PyPI%20Package)](https://pypi.org/project/openbb/) -The first financial terminal that is free and fully open source. With over 600 commands, the terminal has access to equity, options, crypto, forex, macro economy, fixed income, alternative datasets, and more. - -Sign up to the [OpenBB Hub](https://my.openbb.co/login) to use our Windows or MacOS installers to get started. +The first financial Platform that is free and fully open source. Offers access to equity, options, crypto, forex, macro economy, fixed income, and more while also offering a broad range of extensions to enhance the user experience according to their needs. - -

Getting started with the OpenBB Terminal

- - -

-

- - OpenBB Terminal Illustration - -

-

- - ≪ INSTALL - -   ·   - - DATA - -   ·   - - SEE FEATURES - -   ·   - - CONTRIBUTING » - -

-

+Sign up to the [OpenBB Hub](https://my.openbb.co/login) to get the most out of the OpenBB ecosystem.
@@ -75,20 +47,11 @@ Sign up to the [OpenBB Hub](https://my.openbb.co/login) to use our Windows or Ma ## 1. Installation -If you wish to install the OpenBB Terminal or the OpenBB SDK, please use one of the following options: +The OpenBB Platform can be installed as a [PyPI package](https://pypi.org/project/openbb/) by running `pip install openbb` -|**OpenBB Terminal**|**Usage**| -|:-|:-| -|[Windows Installer](https://docs.openbb.co/terminal/installation/windows)|Recommended way for Windows if you just want to use the OpenBB Terminal| -|[MacOS Installer](https://docs.openbb.co/terminal/installation/macos)|Recommended way for MacOS if you just want to use the OpenBB Terminal| -|[Source](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal| -|[Docker](https://docs.openbb.co/terminal/installation/docker)|An alternative way if you just want to use the OpenBB Terminal| +or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git`. -|**OpenBB SDK**         |**Usage**| -|:-|:-| -|[PyPI](https://docs.openbb.co/terminal/installation/pypi)|If you wish to use the OpenBB SDK in Python or Jupyter Notebooks| -|[Source](https://docs.openbb.co/terminal/installation/source)|If you wish to contribute to the development of the OpenBB Terminal| - +Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/platform/installation). ## 2. Contributing @@ -96,7 +59,7 @@ There are three main ways of contributing to this project. (Hopefully you have s ### Become a Contributor -* More information on our [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md). +* More information on our [Contributing Documentation](https://docs.openbb.co/platform/development/contributing). ### Create a GitHub ticket @@ -115,6 +78,8 @@ We are most active on [our Discord](https://openbb.co/discord), but feel free to Distributed under the MIT License. See [LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE) for more information. + + ## 4. Disclaimer Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment From 070f48cc0fdcef6b85a295f3f82354096868c4cf Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Mon, 13 May 2024 15:38:25 +0100 Subject: [PATCH 2/8] lints --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6c01d0555b05..3ea7a27a7d3a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ However, we are committed to continuing our mission to democratize investment re To achieve that, we are working on a new CLI tool built on top of the OpenBB Platform that will soon be available to everyone for free. [![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases) + --- +
OpenBB Terminal logo OpenBB Terminal logo From 1273c95d12e84ac18d4e7ded9bfdeab5c53f866f Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Tue, 14 May 2024 14:39:53 +0100 Subject: [PATCH 3/8] mention platform cli --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 3ea7a27a7d3a..a61b79a78164 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,18 @@ or by cloning the repository directly with `git clone https://github.com/OpenBB- Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/platform/installation). +### OpenBB Platform CLI installation + +The OpenBB Platform CLI is a command-line interface that allows you to access the OpenBB Platform directly from your terminal. + +It can be installed by running `pip install openbb-cli` + +or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git`. + +Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/cli/installation). + +> The OpenBB Platform CLI offers an alternative to the former [OpenBB Terminal](https://github.com/OpenBB-finance/LegacyTerminal) as it has the same look and feel while offering the functionalities and extendability of the OpenBB Platform. + ## 2. Contributing There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️) From 616ed21f7fd762e1220f30e7155817b5c68f6e0f Mon Sep 17 00:00:00 2001 From: Henrique Joaquim Date: Tue, 14 May 2024 15:21:43 +0100 Subject: [PATCH 4/8] test platform imgs --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a61b79a78164..f114c4098d4e 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,12 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla ---
-OpenBB Terminal logo -OpenBB Terminal logo +OpenBB Terminal logo +OpenBB Terminal logo

+ [![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) ![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) From d78227a6c9e42a14d1a81af3f7e22cfaf8808672 Mon Sep 17 00:00:00 2001 From: Henrique Joaquim Date: Tue, 14 May 2024 15:24:25 +0100 Subject: [PATCH 5/8] Update README.md platform imgs --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f114c4098d4e..d5be2a0af071 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla ---
-OpenBB Terminal logo -OpenBB Terminal logo +OpenBB Terminal logo +OpenBB Terminal logo

From 6cc8274749025c58fa86b98a35c8eefebe07464c Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Tue, 14 May 2024 15:28:16 +0100 Subject: [PATCH 6/8] break line --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d5be2a0af071..bb7dbd15c442 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,9 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla [![PyPI](https://img.shields.io/pypi/v/openbb?color=blue&label=PyPI%20Package)](https://pypi.org/project/openbb/) -The first financial Platform that is free and fully open source. Offers access to equity, options, crypto, forex, macro economy, fixed income, and more while also offering a broad range of extensions to enhance the user experience according to their needs. +The first financial Platform that is free and fully open source. + +Offers access to equity, options, crypto, forex, macro economy, fixed income, and more while also offering a broad range of extensions to enhance the user experience according to their needs. Sign up to the [OpenBB Hub](https://my.openbb.co/login) to get the most out of the OpenBB ecosystem. From 26b6624fcd98c2c05255795f875350f197488707 Mon Sep 17 00:00:00 2001 From: Henrique Joaquim Date: Tue, 14 May 2024 16:06:56 +0100 Subject: [PATCH 7/8] Update to Platform images --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb7dbd15c442..0e816f4038ca 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,11 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla ---
-OpenBB Terminal logo -OpenBB Terminal logo +OpenBB Terminal logo +OpenBB Terminal logo

- [![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) ![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) From 2523f66a2fbe81ec2a6f49a8fe5122da514b7315 Mon Sep 17 00:00:00 2001 From: hjoaquim Date: Tue, 14 May 2024 16:07:34 +0100 Subject: [PATCH 8/8] remove old images --- images/openbb-logo-dark.svg | 17 ----------------- images/openbb-logo-light.svg | 17 ----------------- 2 files changed, 34 deletions(-) delete mode 100644 images/openbb-logo-dark.svg delete mode 100644 images/openbb-logo-light.svg diff --git a/images/openbb-logo-dark.svg b/images/openbb-logo-dark.svg deleted file mode 100644 index 75bcef259e11..000000000000 --- a/images/openbb-logo-dark.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/images/openbb-logo-light.svg b/images/openbb-logo-light.svg deleted file mode 100644 index f9c341f7428f..000000000000 --- a/images/openbb-logo-light.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - -