diff --git a/README.md b/README.md index b6137bb262f6..0e816f4038ca 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,17 @@ 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 +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) -[![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 +27,13 @@ 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. +The first financial Platform that is free and fully open source. -Sign up to the [OpenBB Hub](https://my.openbb.co/login) to use our Windows or MacOS installers to get started. +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 +51,23 @@ 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` + +or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git`. -|**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| +Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/platform/installation). -|**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| - +### 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 @@ -96,7 +75,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 +94,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 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 @@ - - - - - - - - - - - - - - - - -