@nuxx/torn-fetch 0.3.0 → 1.0.0

package/README.md

@@ -12,18 +12,35 @@ A TypeScript wrapper around `openapi-fetch` that provides a better developer exp
 ## Installation
 
 ```bash
-npm install @nuxx/use-torn-fetch
+npm install @nuxx/torn-fetch
 ```
 
+## Migration from v0.x
+
+If you're upgrading from v0.x, the main export has been renamed from `useTornFetch` to `tornFetch`. The old name still works in v1.x with a deprecation warning, but will be removed in v2.0.0.
+
+**Migration:**
+```typescript
+// Old (v0.x)
+import { useTornFetch } from '@nuxx/torn-fetch'
+const data = await useTornFetch(apiKey, path)
+
+// New (v1.0+)
+import { tornFetch } from '@nuxx/torn-fetch'
+const data = await tornFetch(apiKey, path)
+```
+
+The function signature and behavior are identical.
+
 ## Usage
 
 ### Basic Usage
 
 ```typescript
-import { useTornFetch } from '@nuxx/use-torn-fetch'
+import { tornFetch } from '@nuxx/torn-fetch'
 
 try {
-  const userAttacks = await useTornFetch( 
+  const userAttacks = await tornFetch( 
     'your-api-key',
     '/user/attacks'
   )
@@ -34,10 +51,10 @@ try {
 ```
 
 ```typescript
-import { useTornFetch } from '@nuxx/use-torn-fetch'
+import { tornFetch } from '@nuxx/torn-fetch'
 
 // Use with path parameters
-const attacks = await useTornFetch(
+const attacks = await tornFetch(
   'your-api-key',
   '/faction/{id}/chain',
   {
@@ -49,10 +66,10 @@ const attacks = await useTornFetch(
 ```
 
 ```typescript
-import { useTornFetch } from '@nuxx/use-torn-fetch'
+import { tornFetch } from '@nuxx/torn-fetch'
 
 // Use with query parameters
-const attacks = await useTornFetch(
+const attacks = await tornFetch(
   'your-api-key',
   '/user/attacks',
   {
@@ -69,10 +86,10 @@ const attacks = await useTornFetch(
 The library automatically throws JavaScript errors when the Torn API returns error responses:
 
 ```typescript
-import { useTornFetch } from '@nuxx/use-torn-fetch'
+import { tornFetch } from '@nuxx/torn-fetch'
 
 try {
-  const userAttacks = await useTornFetch( 
+  const userAttacks = await tornFetch( 
     'invalid-key-abc123',
     '/user/attacks'
   )
@@ -84,9 +101,9 @@ try {
 
 ## API Reference
 
-### `useTornFetch<TPath>(apiKey: string, path: TPath, options?: TParams<TPath>): Promise<TResponse<TPath>>`
+### `tornFetch<TPath>(apiKey: string, path: TPath, options?: TParams<TPath>): Promise<TResponse<TPath>>`
 
-Creates a specialized fetcher function for a specific API endpoint.
+Makes a type-safe call to the Torn API with automatic error handling.
 
 **Parameters:**
 - `apiKey`: Your Torn API key
@@ -104,28 +121,28 @@ Creates a specialized fetcher function for a specific API endpoint.
 ### Prerequisites
 
 - Node.js 18+
-- pnpm
+- Bun
 
 ### Setup
 
 ```bash
 # Install dependencies
-pnpm install
+bun install
 
 # Get the latest Torn API schema and build
-pnpm run build
+bun run build
 ```
 
 ### Scripts
 
-- `pnpm run get-schema` - Downloads the latest Torn API OpenAPI schema and generates TypeScript types
-- `pnpm run build` - Builds the project using Parcel
-- `pnpm run lint` - Runs ESLint on the codebase
-- `pnpm run type-check` - Runs TypeScript type checking
-- `pnpm run test` - Runs the test suite
-- `pnpm run test:watch` - Runs tests in watch mode
-- `pnpm run test:coverage` - Runs tests with coverage reporting
-- `pnpm run ci` - Runs the complete CI pipeline (schema, lint, type-check, test, build)
+- `bun run get-schema` - Downloads the latest Torn API OpenAPI schema and generates TypeScript types
+- `bun run build` - Builds the project using tsup
+- `bun run lint` - Runs ESLint on the codebase
+- `bun run type-check` - Runs TypeScript type checking
+- `bun run test` - Runs the test suite
+- `bun run test:watch` - Runs tests in watch mode
+- `bun run test:coverage` - Runs tests with coverage reporting
+- `bun run ci` - Runs the complete CI pipeline (schema, lint, type-check, test, build)
 
 ## Testing
 
@@ -138,9 +155,9 @@ This package includes comprehensive tests with 100% code coverage. The test suit
 
 Run tests with:
 ```bash
-pnpm test              # Run tests once
-pnpm run test:watch    # Run tests in watch mode
-pnpm run test:coverage # Run tests with coverage report
+bun run test              # Run tests once
+bun run test:watch        # Run tests in watch mode
+bun run test:coverage     # Run tests with coverage report
 ```
 
 See [TESTING.md](./TESTING.md) for detailed testing documentation.
@@ -148,7 +165,7 @@ See [TESTING.md](./TESTING.md) for detailed testing documentation.
 ## Project Structure
 
 ```
-use-torn-fetch/
+torn-fetch/
 ├── coverage/                 # Test coverage reports
 ├── dist/                     # Compiled output
 ├── src/
@@ -161,10 +178,10 @@ use-torn-fetch/
 │   └── torn-api.ts          # Generated TypeScript types
 ├── eslint.config.js         # ESLint configuration
 ├── package.json
-├── pnpm-workspace.yaml      # pnpm workspace configuration
 ├── tsconfig.json            # TypeScript configuration
-├── tsup.config.ts           # Build configuration (legacy)
+├── tsup.config.ts           # Build configuration
 ├── vitest.config.ts         # Test configuration
+├── bun.lock                 # Bun lock file
 ├── TESTING.md               # Testing documentation
 └── README.md
 ```
@@ -174,7 +191,7 @@ use-torn-fetch/
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
-4. Run the full CI pipeline: `pnpm run ci`
+4. Run the full CI pipeline: `bun run ci`
 5. Submit a pull request
 
 All contributions should include appropriate tests and maintain 100% code coverage.