generative-bayesian-network 2.0.0-dev.5 → 2.0.0

package/README.md

@@ -1,3 +1,77 @@
-# Fingerprint suite
+<h1 align="center">
+    <a href="https://apify.github.io/fingerprint-suite/">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/apify/fingerprint-suite/master/website/static/img/logo_big_light.svg">
+          <img alt="Fingerprinting suite" src="https://raw.githubusercontent.com/apify/fingerprint-suite/master/website/static/img/logo_big_dark.svg" width="500">
+        </picture>
+    </a>
+    <br>
+</h1>
 
-This repository contains a set of fingerprinting tools developed by Apify.
+<p align=center>
+    <a href="https://www.npmjs.com/package/fingerprint-injector" rel="nofollow"><img src="https://img.shields.io/npm/v/fingerprint-injector/next.svg" alt="NPM dev version" data-canonical-src="https://img.shields.io/npm/v/fingerprint-injector/next.svg" style="max-width: 100%;"></a>
+    <a href="https://www.npmjs.com/package/fingerprint-injector" rel="nofollow"><img src="https://img.shields.io/npm/dw/fingerprint-injector" alt="Downloads" data-canonical-src="https://img.shields.io/npm/dw/fingerprint-injector" style="max-width: 100%;"></a>
+    <a href="https://discord.gg/jyEM2PRvMU" rel="nofollow"><img src="https://img.shields.io/discord/801163717915574323?label=discord" alt="Chat on discord" data-canonical-src="https://img.shields.io/discord/801163717915574323?label=discord" style="max-width: 100%;"></a>
+    <a href="https://github.com/apify/fingerprint-suite/actions/workflows/test-and-release.yml"><img src="https://github.com/apify/fingerprint-suite/actions/workflows/test-and-release.yml/badge.svg?branch=stable" alt="Build Status" style="max-width: 100%;"></a>
+</p>
+
+`fingerprint-suite` is a handcrafted assembly of tools for browser fingerprint generation and injection.
+Today's websites are increasingly using fingerprinting to track users and identify them.
+With the help of `fingerprint-suite` you can generate and inject browser fingerprints into your browser, allowing you to fly your scrapers under the radar.
+
+**View full documentation, guides and examples on the [fingerprint-suite website](https://apify.github.io/fingerprint-suite/)**
+
+> Would you like to work with us on our fingerprinting tools or similar projects? [We are hiring!](https://apify.com/jobs#senior-node.js-engineer)
+
+## Overview
+
+`fingerprint-suite` is a modular toolkit for browser fingerprint generation and injection. It consists of the following `npm` packages, which you can use separately, or together:
+
+- [`header-generator`](https://www.npmjs.com/package/header-generator): generates configurable, realistic HTTP headers
+- [`fingerprint-generator`](https://www.npmjs.com/package/fingerprint-generator): generates realistic browser fingerprints, affecting the HTTP headers and browser JS APIs 
+- [`fingerprint-injector`](https://www.npmjs.com/package/fingerprint-injector): injects browser fingerprints into your Playwright or Puppeteer managed browser instance
+- [`generative-bayesian-network`](https://www.npmjs.com/package/generative-bayesian-network): our fast implementation of Bayesian generative network used to generate realistic browser fingerprints
+
+## Quick start
+
+The following example shows how to use the fingerprinting tools to camouflage your Playwright-managed Chromium instance.
+
+```javascript
+const { chromium } = require('playwright');
+const { FingerprintGenerator } = require('fingerprint-generator');
+const { FingerprintInjector } = require('fingerprint-injector');
+
+(async () => {
+    const b = await chromium.launch({headless: false});
+    const ctx = await b.newContext();
+
+    const fingerprintGenerator = new FingerprintGenerator();
+    const fingerprintInjector = new FingerprintInjector();
+
+    const fingerprint = fingerprintGenerator.getFingerprint({
+        'locales': ['cs-CZ'],           // setup your desired fingerprint features
+        'operatingSystems': ['linux'],
+    });
+    await fingerprintInjector.attachFingerprintToPlaywright(ctx, fingerprint);
+
+    // ...and enjoy your undercover browser while using the browser context as usual!
+    const page = await ctx.newPage();
+    await page.goto("https://apify.com");
+})();
+```
+## Support
+
+If you find any bug or issue with any of the fingerprinting tools, please [submit an issue on GitHub](https://github.com/apify/fingerprint-suite/issues).
+For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify) or contact support@apify.com
+
+## Contributing
+
+Your code contributions are welcome and you'll be praised to eternity!
+If you have any ideas for improvements, either submit an issue or create a pull request.
+For contribution guidelines and the code of conduct,
+see [CONTRIBUTING.md](https://github.com/apify/fingerprint-suite/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is licensed under the Apache License 2.0 -
+see the [LICENSE.md](https://github.com/apify/fingerprint-suite/blob/master/LICENSE.md) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "generative-bayesian-network",
-    "version": "2.0.0-dev.5",
+    "version": "2.0.0",
     "author": {
         "name": "Apify"
     },
@@ -20,7 +20,7 @@
     "dependencies": {
         "adm-zip": "^0.5.9"
     },
-    "description": "An implementation of a bayesian network usable for .",
+    "description": "An fast implementation of a generative bayesian network.",
     "homepage": "https://github.com/apify/generative-bayesian-network#readme",
     "license": "Apache-2.0",
     "repository": {
@@ -29,9 +29,10 @@
     },
     "scripts": {
         "build": "npm run clean && npm run compile",
+        "postbuild": "cp ./README.md ",
         "clean": "rimraf ./dist",
         "compile": "tsc -p tsconfig.build.json && gen-esm-wrapper ./index.js ./index.mjs",
         "copy": "ts-node -T ../../scripts/copy.ts"
     },
-    "gitHead": "76f3807ed63f4205d3f49731a38114718b541cc2"
+    "gitHead": "e498da3001f790772800ae01f83812f34553a5af"
 }