chore: update readme

Author: natemoo-re

.changeset/bright-nails-march.md

@@ -0,0 +1,5 @@
+---
+"ultraflag": patch
+---
+
+Update README

README.md

@@ -1,9 +1,35 @@
 # `ultraflag`
 
-A <1kB library for parsing CLI flags.
+A <1kB library for parsing CLI flags. Inspired by Deno's `std` [`flags`](https://github.com/denoland/deno_std/blob/main/flags/mod.ts) module.
 
 ### Features
 
 - It's very small.
 - It's very fast.
-- I need to write docs.
+
+### Usage
+
+Basic usage does not require any configuration.
+
+```js
+import { parse } from "ultraflag";
+
+// my-cli build --bundle -rf --a value --b=value --c 1
+const argv = process.argv.slice(2);
+const args = parse(argv);
+
+console.log(args);
+// { _: ['build'], bundle: true, r: true, f: true, a: "value", b: "value", c: 1 }
+```
+
+Parsing can be configured to ensure values are handled in a certain format.
+
+```js
+const args = parse(argv, {
+  default: { a: 1, b: 2, c: "value" },
+  alias: { h: "help" },
+  boolean: ["foo", "bar"],
+  string: ["baz", "qux"],
+  array: ["input"],
+});
+```

src/index.ts

@@ -6,7 +6,6 @@ import type {
   BooleanType,
   StringType,
   Collectable,
-  Negatable,
   Aliases,
 } from "./types.js";
 export { ParseOptions, Args } from "./types.js";
@@ -69,14 +68,13 @@ export function parse<
     TBooleans,
     TStrings,
     TCollectable,
-    TNegatable,
+    undefined,
     TDefaults,
     TAliases
   >,
   TBooleans extends BooleanType = undefined,
   TStrings extends StringType = undefined,
   TCollectable extends Collectable = undefined,
-  TNegatable extends Negatable = undefined,
   TDefaults extends Record<string, unknown> | undefined = undefined,
   TAliases extends Aliases<TAliasArgNames, TAliasNames> | undefined = undefined,
   TAliasArgNames extends string = string,

src/types.ts

@@ -211,25 +211,16 @@ type ValueOf<TValue> = TValue[keyof TValue];
 /** The value returned from `parse`. */
 export type Args<
   // deno-lint-ignore no-explicit-any
-  TArgs extends Record<string, unknown> = Record<string, any>,
-  TDoubleDash extends boolean | undefined = undefined,
+  TArgs extends Record<string, unknown> = Record<string, any>
 > = Id<
   & TArgs
   & {
     /** Contains all the arguments that didn't have an option associated with
      * them. */
     _: Array<string | number | boolean>;
   }
-  & (boolean extends TDoubleDash ? DoubleDash
-    : true extends TDoubleDash ? Required<DoubleDash>
-    : Record<never, never>)
 >;
 
-type DoubleDash = {
-  /** Contains all the arguments that appear after the double dash: "--". */
-  "--"?: Array<string>;
-};
-
 /** The options for the `parse` call. */
 export interface ParseOptions<
   TBooleans extends BooleanType = BooleanType,