diff --git a/README.md b/README.md index d1cd716..c976617 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,9 @@ This library uses the first method for two reasons: The choice to use [Ava](https://avajs.dev) was made because it 1. supports TypeScript and ESM out of the box -2. parallelizes tests in separate environments making it typically faster +2. parallelizes tests in separate environments making ava typically faster 3. does not mutate Node.js globals like Jest -4. follows a similar convention as the node test runner which we may adopt eventually +4. follows a similar convention as the node test runner which we may eventually adopt Running tests requires building the source code first, which should be handled for you by lerna. diff --git a/packages/fastify/README.md b/packages/fastify/README.md index 95b0c55..a9237d1 100644 --- a/packages/fastify/README.md +++ b/packages/fastify/README.md @@ -6,11 +6,11 @@ ```javascript import Fastify from 'fastify' -import {ByuLogger} from '@byu-oit/logger' -import {ByuJwtProvider} from '@byu-oit/fastify-jwt' +import { ByuLogger } from '@byu-oit/logger' +import { ByuJwtProvider } from '@byu-oit/fastify-jwt' const logger = ByuLogger() -const fastify = Fastify({logger}) +const fastify = Fastify({ logger }) fastify.register(ByuJwtProvider, { /** Only authenticate routes matching this prefix */ diff --git a/packages/jwt/README.md b/packages/jwt/README.md index 70abfc7..b294390 100644 --- a/packages/jwt/README.md +++ b/packages/jwt/README.md @@ -5,17 +5,17 @@ ## Usage ```javascript -import {ByuJwt} from '@byu-oit/jwt' +import { ByuJwt } from '@byu-oit/jwt' -const byuJwt = new ByuJwt({issuer: 'https://api.byu.edu'}) +const byuJwt = new ByuJwt({ issuer: 'https://api.byu.edu' }) const jwt = byuJwt.verify('[your jwt]') /** Access the jwt payload information */ -const {byuId} = jwt.payload +const { byuId } = jwt.payload /** Access the jwt header information */ -const {alg} = jwt.header +const { alg } = jwt.header ``` > **Note**