From 584dea52c475d389c2260d0a9312f805151d2b62 Mon Sep 17 00:00:00 2001 From: bnewbold Date: Thu, 21 Sep 2023 18:07:33 -0700 Subject: [PATCH] tidy up package.json and READMEs (#1649) * identity: README example and tidy * tidy up package metadata (package.json files) * updated README headers/stubs for several packages * crypto: longer README, with usage * syntax: tweak README * Apply suggestions from code review Co-authored-by: Eric Bailey Co-authored-by: devin ivy --------- Co-authored-by: Eric Bailey Co-authored-by: devin ivy --- packages/api/package.json | 19 +++++++++---- packages/aws/package.json | 18 ++++++++---- packages/bsky/README.md | 11 ++++++-- packages/bsky/package.json | 8 +++++- packages/common-web/README.md | 11 ++++++-- packages/common-web/package.json | 17 +++++++---- packages/common/README.md | 11 ++++++-- packages/common/package.json | 17 +++++++---- packages/crypto/README.md | 47 +++++++++++++++++++++++++++++-- packages/crypto/package.json | 18 ++++++++---- packages/dev-env/README.md | 9 +++++- packages/dev-env/package.json | 17 +++++++---- packages/identity/README.md | 41 +++++++++++++++++++++++++-- packages/identity/package.json | 19 +++++++++---- packages/lex-cli/package.json | 18 ++++++++---- packages/lexicon/README.md | 13 +++++---- packages/lexicon/package.json | 18 ++++++++---- packages/pds/README.md | 13 +++++++-- packages/pds/package.json | 8 +++++- packages/repo/README.md | 13 +++++++-- packages/repo/package.json | 18 ++++++++---- packages/syntax/README.md | 19 ++++++++++--- packages/syntax/package.json | 20 +++++++++---- packages/xrpc-server/README.md | 7 ++++- packages/xrpc-server/package.json | 18 ++++++++---- packages/xrpc/README.md | 7 ++++- packages/xrpc/package.json | 18 ++++++++---- 27 files changed, 347 insertions(+), 106 deletions(-) diff --git a/packages/api/package.json b/packages/api/package.json index 5e34b416d71..6189e180aa8 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,19 @@ { "name": "@atproto/api", "version": "0.6.15", + "license": "MIT", + "description": "Client library for atproto and Bluesky", + "keywords": [ + "atproto", + "bluesky", + "api" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/api" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", @@ -16,12 +29,6 @@ "bench": "jest --config jest.bench.config.js", "bench:profile": "node --inspect-brk ../../node_modules/.bin/jest --config jest.bench.config.js" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/api" - }, "dependencies": { "@atproto/common-web": "workspace:^", "@atproto/lexicon": "workspace:^", diff --git a/packages/aws/package.json b/packages/aws/package.json index da1de3439ba..3cd4dddcf2e 100644 --- a/packages/aws/package.json +++ b/packages/aws/package.json @@ -1,17 +1,23 @@ { "name": "@atproto/aws", "version": "0.1.1", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/src/index.d.ts" - }, "license": "MIT", + "description": "Shared AWS cloud API helpers for atproto services", + "keywords": [ + "atproto", + "aws" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/aws" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/src/index.d.ts" + }, "scripts": { "build": "node ./build.js", "postbuild": "tsc --build tsconfig.build.json", diff --git a/packages/bsky/README.md b/packages/bsky/README.md index 2b0582044a0..8066ae30e1f 100644 --- a/packages/bsky/README.md +++ b/packages/bsky/README.md @@ -1,3 +1,10 @@ -# Bsky App View +# @atproto/bsky: Bluesky AppView Service -The Bsky App View. This contains the indexers and XRPC methods for reading data from the Bsky application. +TypeScript implementation of the `app.bsky` Lexicons backing the https://bsky.app microblogging application. + +[![NPM](https://img.shields.io/npm/v/@atproto/bsky)](https://www.npmjs.com/package/@atproto/bsky) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +## License + +MIT License diff --git a/packages/bsky/package.json b/packages/bsky/package.json index 2ee0f9bd7d3..aac20db5209 100644 --- a/packages/bsky/package.json +++ b/packages/bsky/package.json @@ -2,9 +2,15 @@ "name": "@atproto/bsky", "version": "0.0.6", "license": "MIT", + "description": "Reference implementation of app.bsky App View (Bluesky API)", + "keywords": [ + "atproto", + "bluesky" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/bsky" }, "main": "src/index.ts", diff --git a/packages/common-web/README.md b/packages/common-web/README.md index 0eb7f5c3e04..74426aebe37 100644 --- a/packages/common-web/README.md +++ b/packages/common-web/README.md @@ -1,3 +1,10 @@ -# ATP Common Library for Web +# @atproto/common-web -A library containing code which is shared between web-friendly ATP packages. +Shared TypeScript code for other `@atproto/*` packages, which is web-friendly (runs in-browser). + +[![NPM](https://img.shields.io/npm/v/@atproto/common)](https://www.npmjs.com/package/@atproto/common-web) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +## License + +MIT License diff --git a/packages/common-web/package.json b/packages/common-web/package.json index 92387c502ab..ad5ee4d8ff3 100644 --- a/packages/common-web/package.json +++ b/packages/common-web/package.json @@ -1,17 +1,22 @@ { "name": "@atproto/common-web", "version": "0.2.0", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/index.d.ts" - }, "license": "MIT", + "description": "Shared web-platform-friendly code for atproto libraries", + "keywords": [ + "atproto" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/common-web" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/index.d.ts" + }, "scripts": { "test": "jest", "build": "node ./build.js", diff --git a/packages/common/README.md b/packages/common/README.md index 1c5a0609639..c08104cebe1 100644 --- a/packages/common/README.md +++ b/packages/common/README.md @@ -1,3 +1,10 @@ -# ATP Common Library +# @atproto/common -A library containing code which is shared between ATP packages. +Shared TypeScript code for other `@atproto/*` packages. This package is oriented towards writing servers, and is not designed to be browser-compatible. + +[![NPM](https://img.shields.io/npm/v/@atproto/common)](https://www.npmjs.com/package/@atproto/common) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +## License + +MIT License diff --git a/packages/common/package.json b/packages/common/package.json index c7f518c1a99..4794bdae698 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -1,17 +1,22 @@ { "name": "@atproto/common", "version": "0.3.0", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/index.d.ts" - }, "license": "MIT", + "description": "Shared web-platform-friendly code for atproto libraries", + "keywords": [ + "atproto" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/common" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/index.d.ts" + }, "scripts": { "test": "jest", "build": "node ./build.js", diff --git a/packages/crypto/README.md b/packages/crypto/README.md index 2258451f7ca..0b610bf7f6f 100644 --- a/packages/crypto/README.md +++ b/packages/crypto/README.md @@ -1,3 +1,46 @@ -# ATP Crypto Library +# @atproto/crypto -ATP's common cryptographic operations. +TypeScript library providing basic cryptographic helpers as needed in [atproto](https://atproto.com). + +[![NPM](https://img.shields.io/npm/v/@atproto/crypto)](https://www.npmjs.com/package/@atproto/crypto) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +This package implements the two currently supported cryptographic systems: + +- P-256 elliptic curve: aka "NIST P-256", aka secp256r1 (note the r), aka prime256v1 +- K-256 elliptic curve: aka "NIST K-256", aka secp256k1 (note the k) + +The details of cryptography in atproto are described in [the specification](https://atproto.com/specs/cryptography). This includes string encodings, validity of "low-S" signatures, byte representation "compression", hashing, and more. + +## Usage + +```typescript +import { verifySignature, Secp256k1Keypair, P256Keypair } from '@atproto/crypto' + +// generate a new random K-256 private key +const keypair = await Secp256k1Keypair.create({ exportable: true }) + +// sign binary data, resulting signature bytes. +// SHA-256 hash of data is what actually gets signed. +// signature output is often base64-encoded. +const data = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]) +const sig = await keypair.sign(data) + +// serialize the public key as a did:key string, which includes key type metadata +const pubDidKey = keypair.did() +console.log(pubDidKey) + +// output would look something like: 'did:key:zQ3shVRtgqTRHC7Lj4DYScoDgReNpsDp3HBnuKBKt1FSXKQ38' + +// verify signature using public key +const ok = verifySignature(pubDidKey, data, sig) +if (!ok) { + throw new Error('Uh oh, something is fishy') +} else { + console.log('Success') +} +``` + +## License + +MIT License diff --git a/packages/crypto/package.json b/packages/crypto/package.json index c1d7fa5b521..7b552ca6b43 100644 --- a/packages/crypto/package.json +++ b/packages/crypto/package.json @@ -1,17 +1,23 @@ { "name": "@atproto/crypto", "version": "0.2.2", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/index.d.ts" - }, "license": "MIT", + "description": "Library for cryptographic keys and signing in atproto", + "keywords": [ + "atproto", + "cryptography" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/crypto" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/index.d.ts" + }, "scripts": { "test": "jest ", "build": "node ./build.js", diff --git a/packages/dev-env/README.md b/packages/dev-env/README.md index c1a41e692fe..60befbe44ca 100644 --- a/packages/dev-env/README.md +++ b/packages/dev-env/README.md @@ -1,7 +1,10 @@ -# ATP Developer Environment +# @atproto/dev-env: Local Developer Environment A command-line application for developers to construct and manage development environments. +[![NPM](https://img.shields.io/npm/v/@atproto/dev-env)](https://www.npmjs.com/package/@atproto/dev-env) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + ## REPL API The following methods are available in the REPL. @@ -25,3 +28,7 @@ Create a new user. ### `user(handle: string): ServiceClient` Get the `ServiceClient` for the given user. + +## License + +MIT License diff --git a/packages/dev-env/package.json b/packages/dev-env/package.json index ad7b0f420b0..d36a4ab1324 100644 --- a/packages/dev-env/package.json +++ b/packages/dev-env/package.json @@ -1,18 +1,23 @@ { "name": "@atproto/dev-env", "version": "0.2.6", + "license": "MIT", + "description": "Local development environment helper for atproto development", + "keywords": [ + "atproto" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/dev-env" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", "types": "dist/index.d.ts" }, "bin": "dist/bin.js", - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/dev-env" - }, "scripts": { "build": "node ./build.js", "postbuild": "tsc --build tsconfig.build.json", diff --git a/packages/identity/README.md b/packages/identity/README.md index c6d940f448e..874fe23570e 100644 --- a/packages/identity/README.md +++ b/packages/identity/README.md @@ -1,3 +1,40 @@ -# ATP DID Resolver +# @atproto/identity -A library for resolving ATP's Decentralized ID methods. +TypeScript library for decentralized identities in [atproto](https://atproto.com) using DIDs and handles + +[![NPM](https://img.shields.io/npm/v/@atproto/identity)](https://www.npmjs.com/package/@atproto/identity) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +## Example + +Resolving a Handle and verifying against DID document: + +```typescript +const didres = new DidResolver({}) +const hdlres = new HandleResolver({}) + +const handle = 'atproto.com' +const did = await hdlres.resolve(handle) + +if (did == undefined) { + throw new Error('expected handle to resolve') +} +console.log(did) // did:plc:ewvi7nxzyoun6zhxrhs64oiz + +const doc = await didres.resolve(did) +console.log(doc) + +// additional resolutions of same DID will be cached for some time, unless forceRefresh flag is used +const doc2 = await didres.resolve(did, true) + +// helper methods use the same cache +const data = await didres.resolveAtprotoData(did) + +if (data.handle != handle) { + throw new Error('invalid handle (did not match DID document)') +} +``` + +## License + +MIT License diff --git a/packages/identity/package.json b/packages/identity/package.json index 1bd0e3cc3f4..e8b2abcf454 100644 --- a/packages/identity/package.json +++ b/packages/identity/package.json @@ -1,17 +1,24 @@ { "name": "@atproto/identity", "version": "0.2.0", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/index.d.ts" - }, "license": "MIT", + "description": "Library for decentralized identities in atproto using DIDs and handles", + "keywords": [ + "atproto", + "did", + "identity" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/identity" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/index.d.ts" + }, "scripts": { "test": "jest", "test:log": "cat test.log | pino-pretty", diff --git a/packages/lex-cli/package.json b/packages/lex-cli/package.json index 43ddf227fd3..db23ef2e1ce 100644 --- a/packages/lex-cli/package.json +++ b/packages/lex-cli/package.json @@ -1,6 +1,18 @@ { "name": "@atproto/lex-cli", "version": "0.2.1", + "license": "MIT", + "description": "TypeScript codegen tool for atproto Lexicon schemas", + "keywords": [ + "atproto", + "lexicon" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/lex-cli" + }, "bin": { "lex": "dist/index.js" }, @@ -14,12 +26,6 @@ "postbuild": "tsc --build tsconfig.build.json", "update-main-to-dist": "node ../../update-main-to-dist.js packages/lex-cli" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/lex-cli" - }, "dependencies": { "@atproto/lexicon": "workspace:^", "@atproto/syntax": "workspace:^", diff --git a/packages/lexicon/README.md b/packages/lexicon/README.md index 7a7b2ed7b20..33fd777ce7f 100644 --- a/packages/lexicon/README.md +++ b/packages/lexicon/README.md @@ -1,10 +1,9 @@ -# Lexicon +# @atproto/lexicon: schema validation library -Lexicon is the semantic schemas & contracts system for ATP. This library provides definitions and APIs for ATP software. +TypeScript implementation of the Lexicon data and API schema description language, which is part of [atproto](https://atproto.com). -``` -npm install @atproto/lexicon -``` +[![NPM](https://img.shields.io/npm/v/@atproto/lexicon)](https://www.npmjs.com/package/@atproto/lexicon) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) ## Usage @@ -29,3 +28,7 @@ lex.assertValidXrpcParams('com.example.query', {...}) lex.assertValidXrpcInput('com.example.procedure', {...}) lex.assertValidXrpcOutput('com.example.query', {...}) ``` + +## License + +MIT diff --git a/packages/lexicon/package.json b/packages/lexicon/package.json index 18f254b6d82..ebce21d48af 100644 --- a/packages/lexicon/package.json +++ b/packages/lexicon/package.json @@ -1,6 +1,18 @@ { "name": "@atproto/lexicon", "version": "0.2.1", + "license": "MIT", + "description": "atproto Lexicon schema language library", + "keywords": [ + "atproto", + "lexicon" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/lexicon" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", @@ -12,12 +24,6 @@ "postbuild": "tsc --build tsconfig.build.json", "update-main-to-dist": "node ../../update-main-to-dist.js packages/lexicon" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/lexicon" - }, "dependencies": { "@atproto/common-web": "workspace:^", "@atproto/syntax": "workspace:^", diff --git a/packages/pds/README.md b/packages/pds/README.md index 547856de3d0..b70d99cb780 100644 --- a/packages/pds/README.md +++ b/packages/pds/README.md @@ -1,3 +1,12 @@ -# ATP Personal Data Server (PDS) +# @atproto/pds: Personal Data Server (PDS) -The Personal Data Server (PDS). This is ATP's main server-side implementation. +TypeScript reference implementation of an atproto PDS. + +[![NPM](https://img.shields.io/npm/v/@atproto/pds)](https://www.npmjs.com/package/@atproto/pds) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +If you are interested in self-hosting a PDS, you probably want this repository instead, which has a thin service wrapper, documentation, a Dockerfile, etc: https://github.com/bluesky-social/pds + +## License + +MIT License diff --git a/packages/pds/package.json b/packages/pds/package.json index 469d1523d1d..384eee10d9d 100644 --- a/packages/pds/package.json +++ b/packages/pds/package.json @@ -2,9 +2,15 @@ "name": "@atproto/pds", "version": "0.1.15", "license": "MIT", + "description": "Reference implementation of atproto Personal Data Server (PDS)", + "keywords": [ + "atproto", + "pds" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/pds" }, "main": "src/index.ts", diff --git a/packages/repo/README.md b/packages/repo/README.md index 53c83a3071c..e018cf76ff8 100644 --- a/packages/repo/README.md +++ b/packages/repo/README.md @@ -1,3 +1,12 @@ -# ATP Repo +# @atproto/repo: Repository and MST -The "ATP repository" core implementation (a Merkle Search Tree). +TypeScript library for atproto repositories, and in particular the Merkle Search Tree (MST) data structure. + +[![NPM](https://img.shields.io/npm/v/@atproto/repo)](https://www.npmjs.com/package/@atproto/repo) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) + +Repositories in atproto are signed key/value stores containing CBOR-encoded data records. The structure and implementation details are described in [the specification](https://atproto.com/specs/repository). This includes MST node format, serialization, structural constraints, and more. + +## License + +MIT License diff --git a/packages/repo/package.json b/packages/repo/package.json index 7ea37ca4d03..bcb9d5eb452 100644 --- a/packages/repo/package.json +++ b/packages/repo/package.json @@ -1,17 +1,23 @@ { "name": "@atproto/repo", "version": "0.3.1", - "main": "src/index.ts", - "publishConfig": { - "main": "dist/index.js", - "types": "dist/index.d.ts" - }, "license": "MIT", + "description": "atproto repo and MST implementation", + "keywords": [ + "atproto", + "mst" + ], + "homepage": "https://atproto.com", "repository": { "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", + "url": "https://github.com/bluesky-social/atproto", "directory": "packages/repo" }, + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js", + "types": "dist/index.d.ts" + }, "scripts": { "test": "jest", "test:profile": "node --inspect ../../node_modules/.bin/jest", diff --git a/packages/syntax/README.md b/packages/syntax/README.md index 5bc6c01b646..0658b64d59c 100644 --- a/packages/syntax/README.md +++ b/packages/syntax/README.md @@ -1,9 +1,16 @@ -# Syntax +# @atproto/syntax: validation helpers for identifier strings -Validation logic for AT identifiers - DIDs, Handles, NSIDs, and AT URIs. +Validation logic for [atproto](https://atproto.com) identifiers - DIDs, Handles, NSIDs, and AT URIs. + +[![NPM](https://img.shields.io/npm/v/@atproto/crypto)](https://www.npmjs.com/package/@atproto/syntax) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) ## Usage +### Handles + +Syntax specification: + ```typescript import { isValidHandle, ensureValidHandle, isValidDid } from '@atproto/syntax' @@ -17,7 +24,9 @@ ensureValidDid('did:method:val') // returns void ensureValidDid(':did:method:val') // throws ``` -## NameSpaced IDs (NSID) +### NameSpaced IDs (NSID) + +Syntax specification: ```typescript import { NSID } from '@atproto/syntax' @@ -43,7 +52,9 @@ NSID.isValid('example.com/foo') // => false NSID.isValid('foo') // => false ``` -## AT URI +### AT URI + +Syntax specification: ```typescript import { AtUri } from '@atproto/syntax' diff --git a/packages/syntax/package.json b/packages/syntax/package.json index 0be28698de7..54488519d50 100644 --- a/packages/syntax/package.json +++ b/packages/syntax/package.json @@ -1,6 +1,20 @@ { "name": "@atproto/syntax", "version": "0.1.1", + "license": "MIT", + "description": "Validation for atproto identifiers and formats: DID, handle, NSID, AT URI, etc", + "keywords": [ + "atproto", + "did", + "nsid", + "at-uri" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/syntax" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", @@ -12,12 +26,6 @@ "postbuild": "tsc --build tsconfig.build.json", "update-main-to-dist": "node ../../update-main-to-dist.js packages/syntax" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/syntax" - }, "dependencies": { "@atproto/common-web": "workspace:^" }, diff --git a/packages/xrpc-server/README.md b/packages/xrpc-server/README.md index 2c297043fdf..03314c342a6 100644 --- a/packages/xrpc-server/README.md +++ b/packages/xrpc-server/README.md @@ -1,4 +1,9 @@ -# XRPC Server API +# @atproto/xrpc-server: atproto HTTP API server library + +TypeScript library for implementing [atproto](https://atproto.com) HTTP API services, with Lexicon schema validation. + +[![NPM](https://img.shields.io/npm/v/@atproto/xrpc-server)](https://www.npmjs.com/package/@atproto/xrpc-server) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) ## Usage diff --git a/packages/xrpc-server/package.json b/packages/xrpc-server/package.json index b6df825c8d8..2714be3951c 100644 --- a/packages/xrpc-server/package.json +++ b/packages/xrpc-server/package.json @@ -1,6 +1,18 @@ { "name": "@atproto/xrpc-server", "version": "0.3.1", + "license": "MIT", + "description": "atproto HTTP API (XRPC) server library", + "keywords": [ + "atproto", + "xrpc" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/xrpc-server" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", @@ -12,12 +24,6 @@ "postbuild": "tsc --build tsconfig.build.json", "update-main-to-dist": "node ../../update-main-to-dist.js packages/xrpc-server" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/xrpc-server" - }, "dependencies": { "@atproto/common": "workspace:^", "@atproto/crypto": "workspace:^", diff --git a/packages/xrpc/README.md b/packages/xrpc/README.md index bfb0b8778c3..5789302658e 100644 --- a/packages/xrpc/README.md +++ b/packages/xrpc/README.md @@ -1,4 +1,9 @@ -# XRPC API +# @atproto/xrpc: atproto HTTP API Client + +TypeScript client library for talking to [atproto](https://atproto.com) services, with Lexicon schema validation. + +[![NPM](https://img.shields.io/npm/v/@atproto/xrpc)](https://www.npmjs.com/package/@atproto/xrpc) +[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml) ## Usage diff --git a/packages/xrpc/package.json b/packages/xrpc/package.json index f6358602256..68ee51b35b8 100644 --- a/packages/xrpc/package.json +++ b/packages/xrpc/package.json @@ -1,6 +1,18 @@ { "name": "@atproto/xrpc", "version": "0.3.1", + "license": "MIT", + "description": "atproto HTTP API (XRPC) client library", + "keywords": [ + "atproto", + "xrpc" + ], + "homepage": "https://atproto.com", + "repository": { + "type": "git", + "url": "https://github.com/bluesky-social/atproto", + "directory": "packages/xrpc" + }, "main": "src/index.ts", "publishConfig": { "main": "dist/index.js", @@ -11,12 +23,6 @@ "postbuild": "tsc --build tsconfig.build.json", "update-main-to-dist": "node ../../update-main-to-dist.js packages/xrpc" }, - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/bluesky-social/atproto.git", - "directory": "packages/xrpc" - }, "dependencies": { "@atproto/lexicon": "workspace:^", "zod": "^3.21.4"