chore: update readme

.github/workflows/pull-request.yml

@@ -7,15 +7,6 @@ on:
             - master
 
 jobs:
-    test:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
-              with:
-                  node-version: 20.11.0
-            - run: yarn install --frozen-lockfile
-            - run: yarn test
     neat:
         runs-on: ubuntu-latest
         steps:

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/

.prettierrc.json

@@ -1,5 +1,6 @@
 {
     "printWidth": 200,
     "tabWidth": 4,
-    "trailingComma": "none"
+    "trailingComma": "none",
+    "singleQuote": false
 }

README.md

@@ -1 +1,26 @@
 # node-curl-impersonate
+
+Fork of [curl-impersonate-node](https://github.com/wearrrrr/curl-impersonate-node) that adds windows support.
+
+## Install
+
+```sh
+# yarn
+yarn add node-curl-impersonate
+
+# npm
+npm i node-curl-impersonate
+```
+
+## Usage
+
+```ts
+// normal request
+const response = await new RequestBuilder().url(/** YOUR URL HERE **/).header("x-foo-bar", "baz").send();
+
+// make a post request
+const response = await new RequestBuilder().url(/** YOUR URL HERE **/).method("POST").body({ foo: "bar" }).send();
+
+// use a browser preset (options vary by platform)
+const response = await new RequestBuilder().url(/** YOUR URL HERE **/).preset({ name: "chrome", version: "110" }).send();
+```

eslint.config.mjs

@@ -5,6 +5,6 @@ export default tseslint.config(eslint.configs.recommended, ...tseslint.configs.r
     rules: {
         semi: "error",
         curly: "error",
-        quotes: ["error", "double"]
+        quotes: ["error", "double", { allowTemplateLiterals: true }]
     }
 });

src/presets.ts

@@ -14,7 +14,7 @@ export type ChromePresetVersion = "107" | "110" | "116";
 export const ChromePresets: Record<ChromePresetVersion, Preset> = {
     "107": {
         headers: {
-            "sec-ch-ua": '\\"Google Chrome\\";v=\\"107\\", \\"Chromium\\";v=\\"107\\", \\"Not=A?Brand\\";v=\\"24\\"',
+            "sec-ch-ua": `\\"Google Chrome\\";v=\\"107\\", \\"Chromium\\";v=\\"107\\", \\"Not=A?Brand\\";v=\\"24\\"`,
             "sec-ch-ua-mobile": "?0",
             "sec-ch-ua-platform": "Windows",
             "Upgrade-Insecure-Requests": "1",
@@ -40,7 +40,7 @@ export const ChromePresets: Record<ChromePresetVersion, Preset> = {
     },
     "110": {
         headers: {
-            "sec-ch-ua": '\\"Chromium\\";v="110\\", \\"Not A(Brand\\";v=\\"24\\", \\"Google Chrome\\";v=\\"110\\"',
+            "sec-ch-ua": `\\"Chromium\\";v="110\\", \\"Not A(Brand\\";v=\\"24\\", \\"Google Chrome\\";v=\\"110\\"`,
             "sec-ch-ua-mobile": "?0",
             "sec-ch-ua-platform": "Windows",
             "Upgrade-Insecure-Requests": "1",
@@ -66,7 +66,7 @@ export const ChromePresets: Record<ChromePresetVersion, Preset> = {
     },
     "116": {
         headers: {
-            "sec-ch-ua": '\\"Chromium\\";v=\\"116\\", \\"Not A;Brand\\";v=\\"99\\", \\"Google Chrome\\";v=\\"116\\"',
+            "sec-ch-ua": `\\"Chromium\\";v=\\"116\\", \\"Not A;Brand\\";v=\\"99\\", \\"Google Chrome\\";v=\\"116\\"`,
             "sec-ch-ua-mobile": "?0",
             "sec-ch-ua-platform": "Windows",
             "Upgrade-Insecure-Requests": "1",

src/request_builder.ts

@@ -429,7 +429,7 @@ export class RequestBuilder {
         const headers = this.buildHeaderFlags({ ...this._headers, ...preset.headers });
         const flags = this.buildFlags(this._flags);
 
-        const command = [path.join(BINARY_PATH, browser.binary), ...flags, ...preset.flags, ...headers, "-s", '-w "\\n%{json}"', `-X ${this._method}`, `"${this._url}"`].join(" ");
+        const command = [path.join(BINARY_PATH, browser.binary), ...flags, ...preset.flags, ...headers, "-s", `-w "\\n%{json}"`, `-X ${this._method}`, `"${this._url}"`].join(" ");
 
         return new Promise((resolve, reject) => {
             exec(command, { cwd: BINARY_PATH }, (err, stdout, stderr) => {