chore: rename

Author: mstephen19

README.md

@@ -1,4 +1,4 @@
-# DirWalk
+# SpeedWalk
 
 [![TypeScript](https://badgen.net/badge/-/TypeScript/blue?icon=typescript&label)](https://www.typescriptlang.org/) [![Install size](https://packagephobia.com/badge?p=dirwalk@latest)](https://packagephobia.com/result?p=dirwalk@latest)
 
@@ -17,7 +17,7 @@ Walk an entire directory. Fast, simple, and asynchronous.
 Import the `walk` function from the package. To call it, pass in a root directory and a callback function accepting a `path` and a `dirent`.
 
 ```TypeScript
-import { walk } from 'dirwalk';
+import { walk } from 'speedwalk';
 
 await walk('./', (path, dirent) => {
     console.log('Path:', path);
@@ -30,7 +30,7 @@ The function will asynchronously traverse the directory and any subsequent direc
 You may want to ignore a directory. Tell `walk` to skip the traversal of a certain directory by returning `true` from the callback.
 
 ```TypeScript
-import { walk } from '../index.js';
+import { walk } from 'speedwalk';
 
 await walk('./', (path, dirent) => {
     console.log('Path:', path);

package.json

@@ -1,5 +1,5 @@
 {
-    "name": "dirwalk",
+    "name": "speedwalk",
     "version": "0.0.1",
     "description": "Walk an entire directory. Fast, simple, and asynchronous.",
     "main": "./build/index.js",
@@ -13,7 +13,11 @@
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/mstephen19/dirwalk"
+        "url": "https://github.com/mstephen19/speedwalk"
+    },
+    "homepage": "https://github.com/mstephen19/speedwalk#readme",
+    "bugs": {
+        "url": "https://github.com/mstephen19/speedwalk/issues"
     },
     "keywords": [
         "walk",

src/index.ts

@@ -1,7 +1,7 @@
 import { opendir } from 'fs/promises';
 import { join } from 'path';
 
-import type { DirWalkCallback } from './types.js';
+import type { WalkDirCallback } from './types.js';
 
 /**
  * Traverse an entire directory's files and all subsequent subdirectories.
@@ -10,7 +10,7 @@ import type { DirWalkCallback } from './types.js';
  * @param callback A callback function to run for each file found.
  * @returns
  */
-export async function walk(root: string, callback: DirWalkCallback): Promise<void> {
+export async function walk(root: string, callback: WalkDirCallback): Promise<void> {
     // Open the directory
     const dir = await opendir(root);
 

src/types.ts

@@ -5,4 +5,4 @@ type Awaitable<T> = T | Promise<T>;
 /**
  * A callback function to run for each file found.
  */
-export type DirWalkCallback = (path: string, dir: Dirent) => Awaitable<void | boolean>;
+export type WalkDirCallback = (path: string, dir: Dirent) => Awaitable<void | boolean>;