Merge pull request tradingview#1311 from tradingview/add-trademarks

add trademark symbols to Lightweight Charts™

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-**Lightweight Charts Version:** <!-- 1.0.0 -->
+**Lightweight Charts™ Version:** <!-- 1.0.0 -->
 
 **Steps/code to reproduce:**
 

BUILDING.md

@@ -1,4 +1,4 @@
-# Building Lightweight Charts
+# Building Lightweight Charts™
 
 The minimal supported version of [NodeJS](https://nodejs.org/) for development is 16.16.
 

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Lightweight Charts
+# Contributing to Lightweight Charts™
 
 ## Issues
 
@@ -23,7 +23,7 @@ When logging a bug, please be sure to include the following:
 
 ## Pull Requests
 
-- Outside contributors may implement enhancement/features only _after an approval_ (label "help wanted") by Lightweight Charts project maintainers.
+- Outside contributors may implement enhancement/features only _after an approval_ (label "help wanted") by Lightweight Charts™ project maintainers.
 - For build instructions/suggestions see [BUILDING.md](./BUILDING.md).
 - After the review process has started, please **don't** use rebase to update the branch, use merge instead.
 

NOTICE

@@ -1,2 +1,2 @@
-TradingView Lightweight Charts
+TradingView Lightweight Charts™
 Copyright (с) 2023 TradingView, Inc. https://www.tradingview.com/

README.md

@@ -5,7 +5,7 @@
     <img width="200" src="https://github.com/tradingview/lightweight-charts/raw/master/.github/logo.svg?sanitize=true">
   </a>
 
-  <h1>Lightweight Charts</h1>
+  <h1>Lightweight Charts™</h1>
 
   [![CircleCI][ci-img]][ci-link]
   [![npm version][npm-version-img]][npm-link]
@@ -18,9 +18,9 @@
 
 [Demos][demo-url] | [Documentation](https://tradingview.github.io/lightweight-charts/) | [Discord community](https://discord.gg/UC7cGkvn4U) | [Reddit](https://www.reddit.com/r/TradingView/)
 
-TradingView Lightweight Charts are one of the smallest and fastest financial HTML5 charts.
+TradingView Lightweight Charts™ are one of the smallest and fastest financial HTML5 charts.
 
-The Lightweight Charts library is the best choice for you if you want to display financial data as an interactive chart on your web page without affecting your web page loading speed and performance.
+The Lightweight Charts™ library is the best choice for you if you want to display financial data as an interactive chart on your web page without affecting your web page loading speed and performance.
 
 It is the best choice for you if you want to replace static image charts with interactive ones.
 The size of the library is close to static images but if you have dozens of image charts on a web page then using this library can make the size of your web page smaller.

package.json

@@ -4,7 +4,7 @@
   "name": "lightweight-charts",
   "author": "TradingView, Inc.",
   "license": "Apache-2.0",
-  "description": "Financial lightweight charts built with HTML5 canvas",
+  "description": "Performant financial charts built with HTML5 canvas",
   "bugs": {
     "url": "https://github.com/tradingview/lightweight-charts/issues"
   },

rollup.config.js

@@ -35,7 +35,7 @@ function getConfig(
 			banner: `
 /*!
  * @license
- * TradingView Lightweight Charts v${currentVersion}
+ * TradingView Lightweight Charts™ v${currentVersion}
  * Copyright (c) ${year} TradingView, Inc.
  * Licensed under Apache License 2.0 https://www.apache.org/licenses/LICENSE-2.0
  */`.trim(),

website/README.md

@@ -1,6 +1,6 @@
-# Lightweight Charts Documentation Website
+# Lightweight Charts™ Documentation Website
 
-The source of the documentation website for Lightweight Charts. This website is built using [Docusaurus 2](https://v2.docusaurus.io/).
+The source of the documentation website for Lightweight Charts™. This website is built using [Docusaurus 2](https://v2.docusaurus.io/).
 
 The aim of this documentation is to make using the library frictionless.
 

website/docs/android.md

@@ -1,6 +1,6 @@
 ---
 id: android
-description: You can use Lightweight Charts inside an Android application. To use Lightweight Charts in that context, you can use our Android wrapper, which will allow you to interact with lightweight charts library, which will be rendered in a web view.
+description: You can use Lightweight Charts™ inside an Android application. To use Lightweight Charts™ in that context, you can use our Android wrapper, which will allow you to interact with Lightweight Charts™ library, which will be rendered in a web view.
 keywords:
     - charts
     - android
@@ -15,7 +15,7 @@ sidebar_position: 7
 # Android wrapper
 
 :::note
-You can find the source code of the Lightweight Charts Android wrapper in [this repository](https://github.com/tradingview/lightweight-charts-android).
+You can find the source code of the Lightweight Charts™ Android wrapper in [this repository](https://github.com/tradingview/lightweight-charts-android).
 :::
 
 :::info
@@ -24,7 +24,7 @@ This wrapper is currently still using `v3.8.0`. This will be updated to `v4.0.0`
 
 :::
 
-You can use Lightweight Charts inside an Android application. To use Lightweight Charts in that context, you can use our Android wrapper, which will allow you to interact with lightweight charts library, which will be rendered in a web view.
+You can use Lightweight Charts™ inside an Android application. To use Lightweight Charts™ in that context, you can use our Android wrapper, which will allow you to interact with Lightweight Charts™ library, which will be rendered in a web view.
 
 ## Installation
 

website/docs/intro.md

@@ -8,7 +8,7 @@ sidebar_position: 0
 
 ## Requirements
 
-First of all, Lightweight Charts is _a client-side_ library.
+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/).

website/docs/ios.md

@@ -1,6 +1,6 @@
 ---
 id: ios
-description: You can use Lightweight Charts inside an iOS application. To use Lightweight Charts in that context, you can use our iOS wrapper, which will allow you to interact with lightweight charts library, which will be rendered in a web view.
+description: You can use Lightweight Charts™ inside an iOS application. To use Lightweight Charts™ in that context, you can use our iOS wrapper, which will allow you to interact with Lightweight Charts™ library, which will be rendered in a web view.
 keywords:
     - charts
     - iOS
@@ -15,7 +15,7 @@ sidebar_position: 6
 # iOS wrapper
 
 :::note
-You can find the source code of the Lightweight Charts iOS wrapper in [this repository](https://github.com/tradingview/LightweightChartsIOS).
+You can find the source code of the Lightweight Charts™ iOS wrapper in [this repository](https://github.com/tradingview/LightweightChartsIOS).
 :::
 
 :::info
@@ -24,7 +24,7 @@ This wrapper is currently still using `v3.8.0`. This will be updated to `v4.0.0`
 
 :::
 
-You can use Lightweight Charts inside an iOS application. To use Lightweight Charts in that context, you can use our iOS wrapper, which will allow you to interact with lightweight charts library, which will be rendered in a web view.
+You can use Lightweight Charts™ inside an iOS application. To use Lightweight Charts™ in that context, you can use our iOS wrapper, which will allow you to interact with Lightweight Charts™ library, which will be rendered in a web view.
 
 ## Installation
 

website/docs/migrations/from-v2-to-v3.md

@@ -1,6 +1,6 @@
 # From v2 to v3
 
-Lightweight charts library 3.0 announces the major improvements: supporting two price scales and improving the time scale API.
+Lightweight Charts™ library 3.0 announces the major improvements: supporting two price scales and improving the time scale API.
 In order of keep the API clear and consistent, we decided to allow breaking change of the API.
 
 In this document you can find the migration guide from the previous version to 3.0.

website/docs/release-notes.md

@@ -19,7 +19,7 @@ sidebar_position: 8
 
 Long overdue as it’s been nearly 1 year since our last major update, but behold before all the changes that have happened over the last 12 months.
 
-In total, more than 20 tickets have been addressed with one of the most important ones being **fancy-canvas** – the library we use to configure HTML canvas in Lightweight Charts.
+In total, more than 20 tickets have been addressed with one of the most important ones being **fancy-canvas** – the library we use to configure HTML canvas in Lightweight Charts™.
 
 Please view the migration guide here: [Migrating from v3 to v4](./migrations/from-v3-to-v4).
 
@@ -81,7 +81,7 @@ Please view the migration guide here: [Migrating from v3 to v4](./migrations/fro
 - Crosshair label text appears on the chart during initial render | [#1255](https://github.com/tradingview/lightweight-charts/issues/1255)
   - Small text artefacts from the crosshair no longer appear on the time axis before any interaction with the chart.
 
-As always, we thank you for your support and help in making Lightweight Charts the best product on the financial web. And a big shout out to our hero contributors [thanhlmm](https://github.com/thanhlmm), [CommanderRoot](https://github.com/CommanderRoot), [samhainsamhainsamhain](https://github.com/samhainsamhainsamhain) & colleague [Nipheris](https://github.com/Nipheris)!
+As always, we thank you for your support and help in making Lightweight Charts™ the best product on the financial web. And a big shout out to our hero contributors [thanhlmm](https://github.com/thanhlmm), [CommanderRoot](https://github.com/CommanderRoot), [samhainsamhainsamhain](https://github.com/samhainsamhainsamhain) & colleague [Nipheris](https://github.com/Nipheris)!
 You can always send us your feedback via GitHub.
 We look forward to hearing from you! And as always, happy trading!
 Team TradingView
@@ -90,7 +90,7 @@ See [issues assigned to this version's milestone](https://github.com/tradingview
 
 ## 3.8.0
 
-We're happy to announce the next release of Lightweight Charts library. This release includes many improvements and bug fixes (as usual), but we are thrilled to say that from this version the library has its own [documentation website](https://tradingview.github.io/lightweight-charts/) that replaces the documentation in the repository. Check it out and share your feedback in [this discussion thread](https://github.com/tradingview/lightweight-charts/discussions/921).
+We're happy to announce the next release of Lightweight Charts™ library. This release includes many improvements and bug fixes (as usual), but we are thrilled to say that from this version the library has its own [documentation website](https://tradingview.github.io/lightweight-charts/) that replaces the documentation in the repository. Check it out and share your feedback in [this discussion thread](https://github.com/tradingview/lightweight-charts/discussions/921).
 
 **Enhancement**
 

website/docusaurus.config.js

@@ -328,7 +328,7 @@ async function getConfig() {
 							],
 						},
 						{
-							title: 'Lightweight Charts Community',
+							title: 'Lightweight Charts™ Community',
 							items: [
 								{
 									label: 'Stack Overflow',

website/src/pages/index.tsx

@@ -188,8 +188,8 @@ const codeBlocks: CodeBlockProps[] = [
 	},
 ];
 
-const header = 'Lightweight Charts Documentation';
-const paragraph = `Lightweight Charts is a library for creating interactive financial charts. This documentation site provides all the information needed to get started with Lightweight Charts and help you make the most of its features.`;
+const header = 'Lightweight Charts™ Documentation';
+const paragraph = `Lightweight Charts™ is a library for creating interactive financial charts. This documentation site provides all the information needed to get started with Lightweight Charts™ and help you make the most of its features.`;
 
 const showBanner = true;
 
@@ -198,7 +198,7 @@ function Index(): JSX.Element {
 		<>
 			{showBanner ? (
 				<Banner
-					text="Big news! Version 4.0 of Lightweight Charts is now available"
+					text="Big news! Version 4.0 of Lightweight Charts™ is now available"
 					link="https://github.com/tradingview/lightweight-charts/releases/tag/v4.0.0"
 					linkText="Read more"
 				/>

website/tutorials/customization/assets/start.html

@@ -7,7 +7,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <style>
       body {
         padding: 0;

website/tutorials/customization/assets/step1.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step10.html

@@ -7,7 +7,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding Google Font -->
     <link rel="preconnect" href="https://fonts.googleapis.com" />
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />

website/tutorials/customization/assets/step2.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step3.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step4.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step5.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step6.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step7.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step8.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/assets/step9.html

@@ -6,7 +6,7 @@
       name="viewport"
       content="width=device-width,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0"
     />
-    <title>Lightweight Charts Customization Tutorial</title>
+    <title>Lightweight Charts™ Customization Tutorial</title>
     <!-- Adding the standalone version of Lightweight charts -->
     <script
       type="text/javascript"

website/tutorials/customization/chart-colors.mdx

@@ -45,7 +45,7 @@ We can set the page background by adding the following code which the `<style>`
 
 ## Applying options
 
-One final explanation before we dive into customizing the chart. There are generally two ways to specify options for an API instance (such as IChartApi, ISeriesApi, IPriceScale, etc...) within Lightweight Charts. The first is to specify the options at the time of creation, and the second is to specify the options at any other time by using the `applyOptions` method. Which approach to use is primarily up to you, however, you can only use the `applyOptions` approach if you are changing the options at a later stage after the instance has been created.
+One final explanation before we dive into customizing the chart. There are generally two ways to specify options for an API instance (such as IChartApi, ISeriesApi, IPriceScale, etc...) within Lightweight Charts™. The first is to specify the options at the time of creation, and the second is to specify the options at any other time by using the `applyOptions` method. Which approach to use is primarily up to you, however, you can only use the `applyOptions` approach if you are changing the options at a later stage after the instance has been created.
 
 This tutorial will make use of both approaches to provide cleaner and easier-to-follow code.
 

website/tutorials/customization/creating-a-chart.mdx

@@ -20,9 +20,9 @@ If you haven't already, please read the [Introduction](intro). At the bottom of
 
 Our first task will be to create a chart and get it visible on the page. A more detailed explanation of these steps is available [here](/docs).
 
-## Adding the Lightweight Charts script
+## Adding the Lightweight Charts™ script
 
-For this example, we will be loading the Lightweight Charts library using the standalone version hosted on a CDN server. This approach allows us to just include the script tag within our HTML file and not be concerned about spinning up a web server to host our files, and thus open the HTML file directly on our computer.
+For this example, we will be loading the Lightweight Charts™ library using the standalone version hosted on a CDN server. This approach allows us to just include the script tag within our HTML file and not be concerned about spinning up a web server to host our files, and thus open the HTML file directly on our computer.
 
 We can add the script tag to the HTML page by including the following code within the `<head>` element of the page. In this case, we will insert the code between the `<title>` and `<style>` elements.
 

website/tutorials/customization/data-points.mdx

@@ -18,7 +18,7 @@ import IterativeGuideWarning from './_iterative-guide-warning-partial.mdx';
 
 In this section, we will modify the candlestick data such that we can individually set the color for each candlestick.
 
-If we take a look at the interface for the candlestick data here: [CandlestickData](/docs/api/interfaces/CandlestickData), we can see a few properties related to color: `color`, `borderColor`, and `wickColor`. Lightweight Charts allows the data points to override the colors specified for series as a whole. In other words, if a datapoint has one of these properties set then it will use that color for that data point instead of the colors used for the rest of the series. We can use this feature to highlight a few key data points in a different color.
+If we take a look at the interface for the candlestick data here: [CandlestickData](/docs/api/interfaces/CandlestickData), we can see a few properties related to color: `color`, `borderColor`, and `wickColor`. Lightweight Charts™ allows the data points to override the colors specified for series as a whole. In other words, if a datapoint has one of these properties set then it will use that color for that data point instead of the colors used for the rest of the series. We can use this feature to highlight a few key data points in a different color.
 
 We are going to change the color of all data points which have a `close` value over `205` to orange. We will use the map higher-order function to go through each data point and either leave it alone if it is below `205` or otherwise add the `color` and `wickColor` properties (set to 'orange'). We don't need to set the `borderColor` because we disabled that in an earlier step.