Skip to content

Commit

Permalink
docs: (README.md) Update with new API
Browse files Browse the repository at this point in the history
  • Loading branch information
dperuo committed Jan 6, 2022
1 parent c1067b8 commit 13887e2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## Quick Start

Import `sweetid()` directly into your project.
Import `mod.ts` directly into your project.

```ts
import { sweetid } from "https://deno.land/x/sweetid/mod.ts";
Expand All @@ -39,7 +39,7 @@ deno run https://deno.land/x/sweetid/cli.ts
We use [Nano ID](https://github.com/ai/nanoid) under the hood to guarantee
high-quality, cryptographically secure IDs.

Sweet ID are alphanumeric and always start with a letter.
Sweet IDs are alphanumeric and always start with a letter.

## ID Length

Expand All @@ -50,7 +50,7 @@ Pass in an optional [`SweetIdSize`](./src/const.ts) as the first argument to set
the output size of the ID.

```ts
sweetid("small" || "s");
sweetid("short" || "s");
// => hBuWX4

sweetid("medium" || "m");
Expand All @@ -67,7 +67,7 @@ Pass in the same `SweetIdSize` as an optional flag to set the output size on the
command line.

```zsh
deno run https://deno.land/x/sweetid/cli.ts --small || -s
deno run https://deno.land/x/sweetid/cli.ts --short || -s
# PLmh1V

deno run https://deno.land/x/sweetid/cli.ts --medium || -m
Expand Down

0 comments on commit 13887e2

Please sign in to comment.