@accept-md/core 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,46 @@
+# @accept-md/core
+
+Core utilities for the [accept-md](https://github.com/hemanthvalsaraj/accept-md) ecosystem: Next.js route scanning, config types, and project detection. Used by the **accept-md** CLI and tooling.
+
+## Installation
+
+```bash
+pnpm add @accept-md/core
+# or npm install @accept-md/core
+```
+
+## API
+
+### `scanProject(projectRoot, options?)`
+
+Scans a Next.js project and returns all routes (App Router and/or Pages Router).
+
+```ts
+import { scanProject } from '@accept-md/core';
+
+const { routes, routerType } = scanProject('/path/to/next-app', {
+  appDir: 'app',      // default
+  pagesDir: 'pages',  // default
+});
+// routes: ParsedRoute[]
+// routerType: 'app' | 'pages' | null
+```
+
+### `scanAppRouter(appDir)` / `scanPagesRouter(pagesDir)`
+
+Scan only App Router or only Pages Router directories.
+
+### Types
+
+- **`ParsedRoute`** – path, segments, router type, source path
+- **`RouteSegment`** – segment name, type (page, layout, etc.), dynamic type
+- **`NextMarkdownConfig`** – config shape for include/exclude, cleanSelectors, cache, transformers, etc.
+- **`RouterType`** – `'app' | 'pages'`
+
+### Config
+
+- **`loadConfig(projectRoot)`** – loads `accept-md.config.js` (re-exported from `accept-md-runtime` for convenience; core defines the types).
+
+## License
+
+MIT · [Repository](https://github.com/hemanthvalsaraj/accept-md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@accept-md/core",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -23,7 +23,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "dependencies": {},
   "devDependencies": {