update readme

Author: Granitosaurus

README.md

@@ -2,36 +2,37 @@
 
 `npm install scrapfly-sdk`
 
-Quick use:
+## Quick Intro
+
+Get your API Key on [scrapfly.io/dashboard](https://scrapfly.io/dashboard) and start scraping:
 
 ```javascript
-import { ScrapflyClient, ScrapeConfig } from "scrapfly-sdk";
-
-const client = new ScrapflyClient({key: "YOUR SCRAPFLY KEY"});
-const result = await client.scrape(new ScrapeConfig({
-    url: "https://httpbin.dev/html",
-    // optional:
-    aps: true,  // enable anti-scraping protection bypass
-    render_js: true, // enable headless browsers for javascript rendering
-    country: "us",  // use a US proxy
-    method: "GET",  // use GET, POST or other type of requests
-    data: {},  // what data to send if POST is used
-    ...
-}))
-console.log(result.result.content)  // html content
+import { ScrapflyClient, ScrapeConfig } from 'scrapfly-sdk';
+
+const key = 'YOUR SCRAPFLY KEY';
+const client = new ScrapflyClient({ key });
+const apiResponse = await client.scrape(
+    new ScrapeConfig({
+        url: 'https://web-scraping.dev/product/1',
+        // optional parameters:
+        // enable javascript rendering
+        render_js: true,
+        // set proxy country
+        country: 'us',
+        // enable anti-scraping protection bypass
+        asp: true,
+        // set residential proxies
+        proxy_pool: 'public_residential_pool',
+        // etc.
+    }),
+);
+console.log(apiResponse.result.content); // html content
 ```
 
-See [/examples](./examples/) for more.
-
-## Get Your API Key
-
-You can create a free account on [Scrapfly](https://scrapfly.io/register) to get your API Key.
-
--   [Usage](https://scrapfly.io/docs/sdk/python)
--   [Python API](https://scrapfly.github.io/python-scrapfly/scrapfly)
--   [Open API 3 Spec](https://scrapfly.io/docs/openapi#get-/scrape)
--   [Scrapy Integration](https://scrapfly.io/docs/sdk/scrapy)
-
+For more see [/examples](/examples/) directory.  
+For more on Scrapfly API see full documentation: <https://scrapfly.io/docs>  
+For Python see [Scrapfly Python SDK](https://github.com/scrapfly/python-scrapfly)  
+    
 ## Development
 
 Install and setup environment:

examples/README.md

@@ -1,38 +1,3 @@
 # Scrapfly Typescript SDK Examples
 
 This directory contains commonly used examples for the Scrapfly Typescript SDK.
-
-## Quick Guide
-
-Install the library using npm:
-
-```shell
-$ npm install scrapfly-sdk
-```
-
-Get your API Key on [scrapfly.io/dashboard](https://scrapfly.io/dashboard) and start scraping:
-
-```javascript
-import { ScrapflyClient, ScrapeConfig } from 'scrapfly-sdk';
-
-const key = 'YOUR SCRAPFLY KEY';
-const client = new ScrapflyClient({ key });
-const apiResponse = await client.scrape(
-    new ScrapeConfig({
-        url: 'https://web-scraping.dev/product/1',
-        // optional parameters:
-        // enable javascript rendering
-        render_js: true,
-        // set proxy country
-        country: 'us',
-        // enable anti-scraping protection bypass
-        asp: true,
-        // set residential proxies
-        proxy_pool: 'public_residential_pool',
-        // etc.
-    }),
-);
-console.log(apiResponse.result.content); // html content
-```
-
-for more see [/examples](/examples/) directory.

package.json

@@ -5,6 +5,11 @@
     "type": "module",
     "types": "build/src/main.d.ts",
     "main": "build/src/main.js",
+    "repository": {"type": "git", "url": "https://github.com/scrapfly/typescript-scrapfly"},
+    "bugs": "https://github.com/scrapfly/typescript-scrapfly/issues",
+    "homepage": "https://scrapfly.io/",
+    "keywords": ["web scraping", "SDK", "scrapfly", "api"],
+    "files": ["build/src"],
     "engines": {
         "node": ">= 18.12 <19"
     },
@@ -35,7 +40,7 @@
         "test:watch": "jest --watch"
     },
     "author": "Bernardas Alisauskas <[email protected]>",
-    "license": "Apache-2.0",
+    "license": "BSD",
     "dependencies": {
         "axios": "^1.4.0",
         "node-fetch": "^3.3.1",