Skip to content

Commit

Permalink
update readme.md to include mention of attributionLogo option
Browse files Browse the repository at this point in the history
  • Loading branch information
SlicedSilver committed Jul 25, 2024
1 parent 7ff6ba9 commit bea721a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ This software incorporates several parts of tslib (<https://github.com/Microsoft
This license requires specifying TradingView as the product creator.
You shall add the "attribution notice" from the 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 this product, we'd be grateful if you add it in a prominent place.
You can use the [`attributionLogo`](https://tradingview.github.io/lightweight-charts/docs/api/interfaces/LayoutOptions#attributionLogo) chart option for displaying an appropriate link to <https://www.tradingview.com/> on the chart itself, which will satisfy the link requirement.

[demo-url]: https://www.tradingview.com/lightweight-charts/

Expand Down
13 changes: 7 additions & 6 deletions src/model/layout-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,14 @@ export interface LayoutOptions {
fontFamily: string;

/**
* Display the 'Charting by TradingView' attribution logo on the main chart pane.
* Display the TradingView attribution logo on the main chart pane.
*
* The licence for library specifies that you shall add the "attribution notice"
* from the 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. Using this
* attribution logo is sufficient for meeting this requirement. However, if you already
* fulfill this requirement then you can disable this attribution logo.
* The licence for library specifies that you add the "attribution notice"
* from the NOTICE file to your code and a link to https://www.tradingview.com/ to
* the page of your website or mobile application that is available to your users.
* Using this attribution logo is sufficient for meeting this linking requirement.
* However, if you already fulfill this requirement then you can disable this
* attribution logo.
*
* @defaultValue true
*/
Expand Down

0 comments on commit bea721a

Please sign in to comment.