@iccandle/selector 0.0.1 → 0.0.43

package/README.md

@@ -1,4 +1,4 @@
-# widget-iccandle
+# @iccandle/selector
 
 React component that wraps an existing [TradingView Charting Library](https://www.tradingview.com/charting-library-docs/) widget and adds ICCandle’s **scanner UI**: a draggable popup to run pattern search over a user-selected bar range, with theming loaded from ICCandle’s API.
 
@@ -7,21 +7,29 @@ Published as ESM and CommonJS; component styles are bundled and injected at runt
 ## Install
 
 ```bash
-npm install widget-iccandle
+npm install @iccandle/selector
 ```
 
+### How to get an API key
+
+1. Register or sign in at the [ICCandle corporate portal](https://corporate-iccandle.vercel.app/).
+2. Use **Create API key** in the dashboard.
+3. When selecting a service, choose **search** so the key is valid for this widget (remote theming, candle cache, and scanner validation).
+
+Issued keys use the format `icc_search_` followed by 48 hexadecimal characters.
+
 ### Prerequisites
 
 - **React 18+** — `react` and `react-dom` are **peer dependencies** (install them in your app).
 - **TradingView Charting Library** — obtain it under your own license from TradingView, host the static assets (e.g. under `/charting_library/` in your public folder), and load the library at runtime. **This package does not ship the charting library.**
-- **ICCandle API key** — format `icc_search_` followed by 48 hex characters, issued by ICCandle for theme, candle cache, and scanner validation.
+- **ICCandle API key** — required for theme, candle cache, and scanner validation; format `icc_search_` plus 48 hex characters. See [How to get an API key](#how-to-get-an-api-key) above.
 
 ## Quick start
 
 ```tsx
 import { useState } from "react";
 import type { IChartingLibraryWidget } from "charting_library/charting_library";
-import { SelectorWidget } from "widget-iccandle";
+import { SelectorWidget } from "@iccandle/selector";
 
 function App() {
   const [chartWidget, setChartWidget] = useState<IChartingLibraryWidget | null>(
@@ -53,7 +61,7 @@ Replace the chart placeholder with your TradingView initialization and pass the
 ### Step 1 — Install the package
 
 ```bash
-npm install widget-iccandle
+npm install @iccandle/selector
 ```
 
 Ensure `react` and `react-dom` are installed and meet the peer version range.
@@ -61,7 +69,7 @@ Ensure `react` and `react-dom` are installed and meet the peer version range.
 ### Step 2 — Host the Charting Library
 
 1. Copy the TradingView Charting Library build into a path your app can serve as static files (e.g. `public/charting_library/` in Vite or Create React App).
-2. Import the library constructor from that path in your bundler setup (see TradingView’s integration docs for your framework). The library is **not** bundled inside `widget-iccandle`; it loads at runtime via `library_path` (or equivalent) on the widget options.
+2. Import the library constructor from that path in your bundler setup (see TradingView’s integration docs for your framework). The library is **not** bundled inside `@iccandle/selector`; it loads at runtime via `library_path` (or equivalent) on the widget options.
 
 ### Step 3 — Bootstrap TradingView and capture the widget instance
 
@@ -119,7 +127,7 @@ You must supply a valid `datafeed`, `symbol`, `interval`, `locale`, and any othe
 `SelectorWidget` must wrap the same subtree that contains the chart container so the scanner overlay positions correctly. Pass the live widget instance (or `null` while mounting):
 
 ```tsx
-import { SelectorWidget } from "widget-iccandle";
+import { SelectorWidget } from "@iccandle/selector";
 
 const widgetKey = "icc_search_..."; // your ICCandle key
 
@@ -177,7 +185,7 @@ import type {
   ResolutionString,
 } from "charting_library/charting_library";
 import { widget } from "charting_library/charting_library";
-import { SelectorWidget } from "widget-iccandle";
+import { SelectorWidget } from "@iccandle/selector";
 
 const LIBRARY_PATH = "/charting_library/";
 const WIDGET_KEY = "icc_search_your48hexcharactershere............";