docs: update

Author: antfu

README.md

@@ -6,9 +6,9 @@
 [![JSDocs][jsdocs-src]][jsdocs-href]
 [![License][license-src]][license-href]
 
-Create sync/async APIs with same, usable logic.
+Create sync/async APIs with usable logic.
 
-**Quan**tum + **Sync** - A "superposition" between `sync` and `async`.
+**Quan**tum + **Sync** - "_Superposition_" between `sync` and `async`.
 
 - Typesafe
 - ESM, modern JavaScript

package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "version": "0.0.0",
   "packageManager": "pnpm@10.2.1",
-  "description": "Create sync/async APIs with same, usable logic",
+  "description": "Create sync/async APIs with usable logic",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/antfu",
@@ -13,7 +13,11 @@
     "url": "git+https://github.com/antfu/quansync.git"
   },
   "bugs": "https://github.com/antfu/quansync/issues",
-  "keywords": [],
+  "keywords": [
+    "async",
+    "sync",
+    "generator"
+  ],
   "sideEffects": false,
   "exports": {
     ".": "./dist/index.mjs"

src/index.ts

@@ -16,6 +16,9 @@ export interface QuansyncYield<R> {
 export type QuansyncGenerator<Return = any, Yield = any> =
   Generator<QuansyncYield<Yield>, Return, Yield>
 
+/**
+ * "Superposition" between async and sync.
+ */
 export type QuansyncFn<Args extends any[] = [], Return = any> =
   ((...args: Args) => QuansyncGenerator<Return>)
   & {