From 2b5c583f574637ecf69a7cfb80e66991be8b14d7 Mon Sep 17 00:00:00 2001 From: Ed Dewhurst Date: Tue, 19 Sep 2023 09:55:33 +0100 Subject: [PATCH 1/2] Add attribution notice section to getting started --- website/docs/intro.md | 14 +++++++++++++- website/versioned_docs/version-3.8/intro.md | 12 ++++++++++++ website/versioned_docs/version-4.0/intro.md | 12 ++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) diff --git a/website/docs/intro.md b/website/docs/intro.md index 8da57e2f46..3227b45179 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -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 is targeted to 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. @@ -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 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. diff --git a/website/versioned_docs/version-3.8/intro.md b/website/versioned_docs/version-3.8/intro.md index 2e386cddd8..8690bbc496 100644 --- a/website/versioned_docs/version-3.8/intro.md +++ b/website/versioned_docs/version-3.8/intro.md @@ -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 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. diff --git a/website/versioned_docs/version-4.0/intro.md b/website/versioned_docs/version-4.0/intro.md index 8da57e2f46..4275a071c8 100644 --- a/website/versioned_docs/version-4.0/intro.md +++ b/website/versioned_docs/version-4.0/intro.md @@ -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 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. From 88e6dabd790389227d2a2b1b02e2afcc8bd68685 Mon Sep 17 00:00:00 2001 From: Ed Dewhurst Date: Tue, 19 Sep 2023 09:58:04 +0100 Subject: [PATCH 2/2] Use targets instead of is targeted to --- website/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/intro.md b/website/docs/intro.md index 3227b45179..6688bb0dab 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -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 the [_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.