Skip to content

Commit

Permalink
fix syntax docs (#1611)
Browse files Browse the repository at this point in the history
  • Loading branch information
estrattonbailey committed Sep 15, 2023
1 parent ba78d22 commit b1dc355
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/tasty-countries-approve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@atproto/syntax': patch
---

Fix imports in `README.md`.
4 changes: 2 additions & 2 deletions packages/syntax/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Syntax

Validation logic for AT identifiers - DIDs, Handles, NSIDs, and AT URIs
Validation logic for AT identifiers - DIDs, Handles, NSIDs, and AT URIs.

## Usage

```typescript
import * as identifier from '@atproto/syntax'
import { isValidHandle, ensureValidHandle, isValidDid } from '@atproto/syntax'

isValidHandle('alice.test') // returns true
ensureValidHandle('alice.test') // returns void
Expand Down

0 comments on commit b1dc355

Please sign in to comment.