@crustjs/core 0.0.19 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chenxin Yan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,6 @@
 # @crustjs/core
 
-The core library for the [Crust](https://crustjs.com) CLI framework.
-
-Provides command definition, argument/flag parsing, subcommand routing, lifecycle hooks, and a plugin system.
+Core library for the Crust CLI framework.
 
 ## Install
 
@@ -10,51 +8,6 @@ Provides command definition, argument/flag parsing, subcommand routing, lifecycl
 bun add @crustjs/core
 ```
 
-## Quick Example
-
-```ts
-import { Crust } from "@crustjs/core";
-
-const app = new Crust("greet")
-	.meta({ description: "Say hello" })
-	.args([{ name: "name", type: "string", default: "world" }] as const)
-	.flags({
-		loud: { type: "boolean", description: "Shout it", alias: "l" },
-	})
-	.run(({ args, flags }) => {
-		const msg = `Hello, ${args.name}!`;
-		console.log(flags.loud ? msg.toUpperCase() : msg);
-	});
-
-app.execute();
-```
-
-## Built-in value types
-
-Flags and positional arguments support six built-in `type` literals:
-
-- `"string"` — raw string token
-- `"number"` — coerced via `Number(raw)`
-- `"boolean"` — toggle (`--flag` / `--no-flag`)
-- `"url"` — `new URL(raw)` → `URL` instance
-- `"path"` — `~` expanded, resolved to an absolute `string`
-- `"json"` — `JSON.parse(raw)` → `unknown`
-
-For formats that aren't built in, attach a synchronous `parse` to a `type: "string"` flag or arg. The inferred type flows from `ReturnType<parse>`:
-
-```ts
-flags: {
-  port: { type: "string", parse: (s) => Number(s), default: "3000" },
-}
-// flags.port: number
-```
-
-See the [Types](https://crustjs.com/docs/guide/types) guide for the full contract, error modes, and copy-paste recipes.
-
 ## Documentation
 
-See the full docs at [crustjs.com](https://crustjs.com).
-
-## License
-
-MIT
+Full docs: [crustjs.com/docs/modules/core](https://crustjs.com/docs/modules/core)