v0.0.1

Author: minai621

.github/workflows/release.yml

@@ -43,7 +43,7 @@ jobs:
           yarn workspace docflow build
           mkdir -p out
           cd packages/cli
-          yarn pack --out ../../out
+          yarn pack --out ../../out/docflow-cli.tgz
 
       - id: extract-changelog
         uses: dahlia/submark@5a5ff0a58382fb812616a5801402f5aef00f90ce
@@ -75,9 +75,9 @@ jobs:
           npm config set //registry.npmjs.org/:_authToken "$NPM_AUTH_TOKEN"
           npm whoami
           if [[ "$GITHUB_REF_TYPE" = "tag" ]]; then
-            npm publish --provenance --access public *.tgz
+            npm publish --provenance --access public docflow-cli.tgz
           else
-            npm publish --provenance --access public --tag dev *.tgz
+            npm publish --provenance --access public --tag dev docflow-cli.tgz
           fi
         env:
           NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## Version v0.0.0
+## Version v0.0.1
 
 Released on July 22nd, 2025.
 

packages/cli/README.md

@@ -0,0 +1,53 @@
+# Docflow · [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/docflow/blob/main/LICENSE) [![NPM badge](https://img.shields.io/npm/v/docflow?logo=npm)](https://www.npmjs.com/package/docflow)
+
+English | [한국어](https://github.com/toss/docflow/blob/main/README-ko_kr.md)
+
+Docflow is a TypeScript-first documentation generator that automatically creates API documentation from JSDoc comments.
+
+- Docflow automatically generates comprehensive documentation from JSDoc comments, supporting essential tags like [@public](https://docflow.dev/reference/public), [@category](https://docflow.dev/reference/category), and [@example](https://docflow.dev/reference/example).
+- Designed with AI integration in mind, Docflow can [generate complete JSDoc comments](https://docflow.dev/features/ai-generation) for your functions with a single `@generate` tag.
+- Docflow provides [accurate TypeScript type extraction](https://docflow.dev/features/typescript), ensuring your documentation always matches your actual code signatures.
+- Docflow includes a powerful plugin system, allowing you to generate documentation for [VitePress](https://docflow.dev/plugins/vitepress), [Docusaurus](https://docflow.dev/plugins/docusaurus), [Nextra](https://docflow.dev/plugins/nextra), and more.
+
+## Examples
+
+```typescript
+import { createCalculator } from "@toss/utils";
+
+/**
+ * @public
+ * @category Math
+ * Creates a calculator instance with the given initial value
+ * @param initialValue - The starting value for calculations
+ * @returns A calculator object with calculation methods
+ * @example
+ * const calc = createCalculator(10);
+ * calc.add(5).multiply(2).getValue(); // 30
+ */
+export function createCalculator(initialValue: number) {
+  return {
+    add: (n: number) => createCalculator(initialValue + n),
+    multiply: (n: number) => createCalculator(initialValue * n),
+    getValue: () => initialValue,
+  };
+}
+```
+
+With just `docflow build`, this becomes a beautiful documentation page with examples, type information, and more.
+
+## Contributing
+
+We welcome contribution from everyone in the community. Read below for detailed contribution guide.
+
+[CONTRIBUTING](https://github.com/toss/docflow/blob/main/.github/CONTRIBUTING.md)
+
+## License
+
+MIT © Toss. See [LICENSE](./LICENSE) for details.
+
+<a title="Toss" href="https://toss.im">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://static.toss.im/logos/png/4x/logo-toss-reverse.png">
+    <img alt="Toss" src="https://static.toss.im/logos/png/4x/logo-toss.png" width="100">
+  </picture>
+</a>

packages/cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docflow",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "exports": {
     ".": "./dist/index.js",
     "./cli": "./dist/cli.js",
@@ -19,7 +19,8 @@
     "lint": "eslint ."
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "engines": {
     "node": ">=22.15.1",
@@ -48,5 +49,9 @@
     "ts-morph": "^22.0.0",
     "unconfig": "^0.3.11",
     "zod": "^3.22.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/toss/docflow"
   }
 }