Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
James Wright committed Aug 24, 2021
1 parent 7015e81 commit adc2686
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![Reno logo](https://raw.githubusercontent.com/reno-router/reno/master/logo/reno-500.png)

[![Build status](https://github.com/reno-router/reno/workflows/CI/badge.svg)](https://github.com/reno-router/reno/actions) [![Deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/[email protected].15/reno/mod.ts) [![Published on Nest.land](https://nest.land/badge.svg)](https://nest.land/package/reno)
[![Build status](https://github.com/reno-router/reno/workflows/CI/badge.svg)](https://github.com/reno-router/reno/actions) [![Deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/[email protected].16/reno/mod.ts) [![Published on Nest.land](https://nest.land/badge.svg)](https://nest.land/package/reno)

Reno is a thin routing library designed to sit on top of [Deno](https://deno.land/)'s [standard HTTP module](https://github.com/denoland/deno/tree/master/std/http).

Expand All @@ -26,10 +26,10 @@ import {
jsonResponse,
streamResponse,
NotFoundError,
} from "https://deno.land/x/[email protected].15/reno/mod.ts";
} from "https://deno.land/x/[email protected].16/reno/mod.ts";

/* Alternatively, you can import Reno from nest.land:
* import { ... } from "https://x.nest.land/[email protected].15/reno/mod.ts";
* import { ... } from "https://x.nest.land/[email protected].16/reno/mod.ts";
*/

function createErrorResponse(status: number, { message }: Error) {
Expand Down Expand Up @@ -86,7 +86,7 @@ await listenAndServe(
This, along with request handlers being [pure functions](https://en.wikipedia.org/wiki/Pure_function), makes unit testing Reno services a breeze:

```ts
import { jsonResponse, assertResponsesAreEqual } from "https://deno.land/x/[email protected].15/reno/mod.ts";
import { jsonResponse, assertResponsesAreEqual } from "https://deno.land/x/[email protected].16/reno/mod.ts";
import { createRonSwansonQuoteHandler } from "./routes.ts";

const createFetchStub = (response: string[]) =>
Expand Down Expand Up @@ -170,7 +170,7 @@ import {
RouteHandler,
textResponse,
createRouteMap
} from "https://deno.land/x/[email protected].15/reno/mod.ts";
} from "https://deno.land/x/[email protected].16/reno/mod.ts";

import isValidAPIKey from "./api_keys.ts";

Expand Down Expand Up @@ -208,7 +208,7 @@ export const routes = createRouteMap([
Additionally, Reno provides a `pipe` utility for creating a higher-order route handler that invokes a sequence of functions against both the original request _and_ the computed response:

```ts
import { createRouteMap, jsonResponse, pipe } from "https://deno.land/x/[email protected].15/reno/mod.ts";
import { createRouteMap, jsonResponse, pipe } from "https://deno.land/x/[email protected].16/reno/mod.ts";

const withCaching = pipe(
(req, res) => {
Expand Down Expand Up @@ -257,11 +257,11 @@ Deno.test("/ should return the expected response", async () => {

## Example Apps

As well as the [example app found in this repo](https://github.com/reno-router/reno/tree/v1.3.15/example), which is targetted by the end-to-end test suite, there is a [standalone repository for a blog microservice](https://github.com/reno-router/blog-microservice) built with Deno, Reno, PostgreSQL, and Docker.
As well as the [example app found in this repo](https://github.com/reno-router/reno/tree/v1.3.16/example), which is targetted by the end-to-end test suite, there is a [standalone repository for a blog microservice](https://github.com/reno-router/blog-microservice) built with Deno, Reno, PostgreSQL, and Docker.

## API Documentation

Consult [Reno's entry on the Deno Doc website](https://doc.deno.land/https/deno.land/x/[email protected].15/reno/mod.ts) for comprehensive documentation on Reno's API.
Consult [Reno's entry on the Deno Doc website](https://doc.deno.land/https/deno.land/x/[email protected].16/reno/mod.ts) for comprehensive documentation on Reno's API.

## Local Development

Expand Down

0 comments on commit adc2686

Please sign in to comment.