Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Main README #6403

Merged
merged 12 commits into from
May 14, 2024
73 changes: 27 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

hjoaquim marked this conversation as resolved.
Show resolved Hide resolved
<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">
<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-dark.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">
Expand All @@ -25,39 +27,13 @@ To achieve that, we are working on a new CLI tool built on top of the OpenBB Pla
<a target="_blank" href="https://colab.research.google.com/github/OpenBB-finance/OpenBBTerminal/blob/develop/examples/googleColab.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>
[![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.

<a href="https://www.youtube.com/playlist?list=PLXcRIKcHAUP45_ZZCxxvPyXFKHdq9kM8T">
<p align="center">Getting started with the OpenBB Terminal</p>
</a>

<p align="center">
<p align="center">
<a href="https://www.youtube.com/playlist?list=PLXcRIKcHAUP45_ZZCxxvPyXFKHdq9kM8T" rel="OpenBB Terminal Demo">
<img src="images/openbb_terminal_illustration.gif" alt="OpenBB Terminal Illustration" width="100%"/>
</a>
</p>
<p align="center">
<a href="https://docs.openbb.co/terminal/installation">
<strong>≪ INSTALL</strong>
</a>
&nbsp · &nbsp
<a href="https://my.openbb.co/app/terminal/data">
<strong>DATA</strong>
</a>
&nbsp · &nbsp
<a href="https://my.openbb.co/app/terminal/features">
<strong>SEE FEATURES</strong>
</a>
&nbsp · &nbsp
<a href="https://github.com/OpenBB-finance/OpenBBTerminal/tree/master/CONTRIBUTING.md">
<strong>CONTRIBUTING »</strong>
</a>
</p>
</p>
Sign up to the [OpenBB Hub](https://my.openbb.co/login) to get the most out of the OpenBB ecosystem.

<!-- TABLE OF CONTENTS -->
<details closed="closed">
Expand All @@ -75,28 +51,31 @@ 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** &nbsp; &nbsp; &nbsp; &nbsp; |**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|
<!-- nbsp;| -->
### 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 ⭐️)

### 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

Expand All @@ -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.

<!-- TODO: Tag Theo to review the license. -->
piiq marked this conversation as resolved.
Show resolved Hide resolved

## 4. Disclaimer

Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment
Expand Down
17 changes: 0 additions & 17 deletions images/openbb-logo-dark.svg

This file was deleted.

17 changes: 0 additions & 17 deletions images/openbb-logo-light.svg

This file was deleted.

Loading