Skip to content

Commit

Permalink
Merge pull request #1427 from tradingview/CLL-254_add_attribution_not…
Browse files Browse the repository at this point in the history
…ice_section

Add license and attribution section to Getting Started
  • Loading branch information
edew committed Sep 19, 2023
2 parents 8255ab4 + 88e6dab commit 85641e3
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
14 changes: 13 additions & 1 deletion website/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 0
First of all, Lightweight Charts™ is _a client-side_ library.
This means that it does not and cannot work on the server-side (i.e. NodeJS), at least out of the box.

The code of `lightweight-charts` package is targeted to [_es2016_ language specification](https://262.ecma-international.org/7.0/).
The code of `lightweight-charts` package targets the [_es2016_ language specification](https://262.ecma-international.org/7.0/).
Thus, all the browsers you will have to work with should support this language revision (see [this compatibility table](https://kangax.github.io/compat-table/es2016plus/)).
If you need to support the previous revisions, you could try to setup a transpilation of the package to the target you need to support in your build system (e.g. by using Babel).
If you'll have any issues with that, please raise an issue on github with the details and we'll investigate possible ways to solve it.
Expand Down Expand Up @@ -39,6 +39,18 @@ The library ships with the following build variants:

⚠️ **Deprecation note:** CommonJS support will be removed from the library at the start of 2024.

## License and attribution

:::tip

The Lightweight Charts™ license requires specifying TradingView as the product creator.

:::

You shall add the "attribution notice" from the [NOTICE](https://github.com/tradingview/lightweight-charts/blob/master/NOTICE) file and a link to <https://www.tradingview.com/> to the page of your website or mobile application that is available to your users.

As thanks for creating Lightweight Charts™, we'd be grateful if you add the attribution notice in a prominent place.

## Creating a chart

Once the library has been installed in your repo you're ready to create your first chart.
Expand Down
12 changes: 12 additions & 0 deletions website/versioned_docs/version-3.8/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ npm install --save lightweight-charts

_Note that the package is shipped with TypeScript declarations, so you can easily use it within TypeScript code._

## License and attribution

:::tip

The Lightweight Charts™ license requires specifying TradingView as the product creator.

:::

You shall add the "attribution notice" from the [NOTICE](https://github.com/tradingview/lightweight-charts/blob/013424ecbf672db80646fe51ee48b187e9b71cec/NOTICE) file and a link to <https://www.tradingview.com/> to the page of your website or mobile application that is available to your users.

As thanks for creating Lightweight Charts™, we'd be grateful if you add the attribution notice in a prominent place.

## Creating a chart

Once the library has been installed in your repo you're ready to create your first chart.
Expand Down
12 changes: 12 additions & 0 deletions website/versioned_docs/version-4.0/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@ The library ships with the following build variants:

⚠️ **Deprecation note:** CommonJS support will be removed from the library at the start of 2024.

## License and attribution

:::tip

The Lightweight Charts™ license requires specifying TradingView as the product creator.

:::

You shall add the "attribution notice" from the [NOTICE](https://github.com/tradingview/lightweight-charts/blob/master/NOTICE) file and a link to <https://www.tradingview.com/> to the page of your website or mobile application that is available to your users.

As thanks for creating Lightweight Charts™, we'd be grateful if you add the attribution notice in a prominent place.

## Creating a chart

Once the library has been installed in your repo you're ready to create your first chart.
Expand Down

0 comments on commit 85641e3

Please sign in to comment.