chore: update README with new overview info

README.md

@@ -2,21 +2,28 @@
 
 [![Documentation badge](https://img.shields.io/badge/docs-here-informational)](https://the-convocation.github.io/twitter-scraper/)
 
-A port of [n0madic/twitter-scraper](https://github.com/n0madic/twitter-scraper)
-to Node.js.
+A port of the now-archived [n0madic/twitter-scraper](https://github.com/n0madic/twitter-scraper) to Node.js.
 
 > Twitter's API is annoying to work with, and has lots of limitations — luckily
 > their frontend (JavaScript) has it's own API, which I reverse-engineered. No
 > API rate limits. No tokens needed. No restrictions. Extremely fast.
 >
 > You can use this library to get the text of any user's Tweets trivially.
 
-Known limitations:
+Many things have changed since X (the company formerly known as Twitter) was acquired in 2022:
 
-- Search operations require logging in with a real user account via
-  `scraper.login()`.
+- Several operations require logging in with a real user account via
+  `scraper.login()`. **While we are not aware of confirmed cases caused
+  by this library, any account you log into with this library is subject
+  to being banned at any time. You have been warned.**
 - Twitter's frontend API does in fact have rate limits
-  ([#11](https://github.com/the-convocation/twitter-scraper/issues/11))
+  ([#11](https://github.com/the-convocation/twitter-scraper/issues/11)).
+  The rate limits are dynamic and sometimes change, so we don't know
+  exactly what they are at all times. Refer to [rate limiting](#rate-limiting)
+  for more information.
+- Twitter's authentication requirements and frontend API endpoints
+  change frequently, breaking this library. Fixes for these issues
+  typically take at least a few days to go out.
 
 ## Installation
 
@@ -62,15 +69,15 @@ const scraper = new Scraper({
       // The arguments here are the same as the parameters to fetch(), and
       // are kept as-is for flexibility of both the library and applications.
       if (input instanceof URL) {
-        const proxy = "https://corsproxy.io/?" +
-          encodeURIComponent(input.toString());
+        const proxy =
+          'https://corsproxy.io/?' + encodeURIComponent(input.toString());
         return [proxy, init];
-      } else if (typeof input === "string") {
-        const proxy = "https://corsproxy.io/?" + encodeURIComponent(input);
+      } else if (typeof input === 'string') {
+        const proxy = 'https://corsproxy.io/?' + encodeURIComponent(input);
         return [proxy, init];
       } else {
         // Omitting handling for example
-        throw new Error("Unexpected request input type");
+        throw new Error('Unexpected request input type');
       }
     },
   },
@@ -87,10 +94,10 @@ front page).
 #### Next.js 13.x example:
 
 ```tsx
-"use client";
+'use client';
 
-import { Scraper, Tweet } from "@the-convocation/twitter-scraper";
-import { useEffect, useMemo, useState } from "react";
+import { Scraper, Tweet } from '@the-convocation/twitter-scraper';
+import { useEffect, useMemo, useState } from 'react';
 
 export default function Home() {
   const scraper = useMemo(
@@ -99,15 +106,15 @@ export default function Home() {
         transform: {
           request(input: RequestInfo | URL, init?: RequestInit) {
             if (input instanceof URL) {
-              const proxy = "https://corsproxy.io/?" +
-                encodeURIComponent(input.toString());
+              const proxy =
+                'https://corsproxy.io/?' + encodeURIComponent(input.toString());
               return [proxy, init];
-            } else if (typeof input === "string") {
-              const proxy = "https://corsproxy.io/?" +
-                encodeURIComponent(input);
+            } else if (typeof input === 'string') {
+              const proxy =
+                'https://corsproxy.io/?' + encodeURIComponent(input);
               return [proxy, init];
             } else {
-              throw new Error("Unexpected request input type");
+              throw new Error('Unexpected request input type');
             }
           },
         },
@@ -118,7 +125,7 @@ export default function Home() {
 
   useEffect(() => {
     async function getTweet() {
-      const latestTweet = await scraper.getLatestTweet("twitter");
+      const latestTweet = await scraper.getLatestTweet('twitter');
       if (latestTweet) {
         setTweet(latestTweet);
       }
@@ -159,11 +166,10 @@ supported directly by interceptors):
 const scraper = new Scraper({
   fetch: (input, init) => {
     // Transform input and init into your function's expected types...
-    return fetch(input, init)
-      .then((res) => {
-        // Transform res into a web-compliant response...
-        return res;
-      });
+    return fetch(input, init).then((res) => {
+      // Transform res into a web-compliant response...
+      return res;
+    });
   },
 });
 ```
@@ -186,7 +192,10 @@ yarn add cycletls
 
 ```ts
 import { Scraper } from '@the-convocation/twitter-scraper';
-import { cycleTLSFetch, cycleTLSExit } from '@the-convocation/twitter-scraper/cycletls';
+import {
+  cycleTLSFetch,
+  cycleTLSExit,
+} from '@the-convocation/twitter-scraper/cycletls';
 
 const scraper = new Scraper({
   fetch: cycleTLSFetch,
@@ -204,6 +213,7 @@ cycleTLSExit();
 See the [cycletls example](./examples/cycletls/) for a complete working example.
 
 ### Rate limiting
+
 The Twitter API heavily rate-limits clients, requiring that the scraper has its own
 rate-limit handling to behave predictably when rate-limiting occurs. By default, the
 scraper uses a rate-limiting strategy that waits for the current rate-limiting period
@@ -216,7 +226,7 @@ scrapers logged-in to different accounts (refer to [#116](https://github.com/the
 implementation to the `rateLimitStrategy` option in the scraper constructor:
 
 ```ts
-import { Scraper, RateLimitStrategy } from "@the-convocation/twitter-scraper";
+import { Scraper, RateLimitStrategy } from '@the-convocation/twitter-scraper';
 
 class CustomRateLimitStrategy implements RateLimitStrategy {
   async onRateLimit(event: RateLimitEvent): Promise<void> {
@@ -231,6 +241,7 @@ const scraper = new Scraper({
 
 More information on this interface can be found on the [`RateLimitStrategy`](https://the-convocation.github.io/twitter-scraper/interfaces/RateLimitStrategy.html)
 page in the documentation. The library provides two pre-written implementations to choose from:
+
 - `WaitingRateLimitStrategy`: The default, which waits for the limit to expire.
 - `ErrorRateLimitStrategy`: A strategy that throws if any rate-limit event occurs.