Skip to content

Commit b4f5f0b

Browse files
authored
some normalization of the shelf readmes (#241)
* some normalization of the shelf readme * remove individual build status badges
1 parent 9f6b9ce commit b4f5f0b

File tree

8 files changed

+26
-11
lines changed

8 files changed

+26
-11
lines changed

pkgs/shelf/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
## Web Server Middleware for Dart
2-
3-
[![Build Status](https://github.com/dart-lang/shelf/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/shelf/actions?query=workflow%3A"Dart+CI"+branch%3Amaster)
1+
[![pub package](https://img.shields.io/pub/v/shelf.svg)](https://pub.dev/packages/shelf)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf.svg)](https://pub.dev/packages/shelf/publisher)
43

5-
## Introduction
4+
## Web Server Middleware for Dart
65

76
**Shelf** makes it easy to create and compose **web servers** and **parts of web
87
servers**. How?

pkgs/shelf_packages_handler/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![pub package](https://img.shields.io/pub/v/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_packages_handler.svg)](https://pub.dev/packages/shelf_packages_handler/publisher)
3+
14
A package that provides a [shelf][] handler for serving a `packages/` directory.
25
It's intended to be usable as the first handler in a [`Cascade`][cascade], where
36
any requests that include `/packages/` are served package assets, and all other

pkgs/shelf_proxy/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
## Proxy for Shelf
1+
[![pub package](https://img.shields.io/pub/v/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_proxy.svg)](https://pub.dev/packages/shelf_proxy/publisher)
23

3-
[![Build Status](https://github.com/dart-lang/shelf/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/shelf/actions?query=workflow%3A"Dart+CI"+branch%3Amaster)
4+
## Proxy for Shelf
45

56
`shelf_proxy` is a [Shelf][] handler that proxies requests to an external
67
server. It can be served directly and used as a proxy server, or it can be

pkgs/shelf_router/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Web Request Router for Shelf
1+
[![pub package](https://img.shields.io/pub/v/shelf_router.svg)](https://pub.dev/packages/shelf_router)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_router.svg)](https://pub.dev/packages/shelf_router/publisher)
3+
4+
## Web Request Router for Shelf
25

36
[Shelf][shelf] makes it easy to build web
47
applications in Dart by composing request handlers. This package offers a

pkgs/shelf_router_generator/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Shelf Router Generator
2-
======================
1+
[![pub package](https://img.shields.io/pub/v/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_router_generator.svg)](https://pub.dev/packages/shelf_router_generator/publisher)
3+
4+
## Shelf Router Generator
35

46
[Shelf](https://pub.dartlang.org/packages/shelf) makes it easy to build web
57
applications in Dart by composing request handlers. The `shelf_router` package

pkgs/shelf_static/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
`shelf_static` is a `Handler` for the Dart `shelf` package.
1+
[![pub package](https://img.shields.io/pub/v/shelf_static.svg)](https://pub.dev/packages/shelf_static)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_static.svg)](https://pub.dev/packages/shelf_static/publisher)
23

3-
[![Build Status](https://github.com/dart-lang/shelf/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/shelf/actions?query=workflow%3A"Dart+CI"+branch%3Amaster)
4+
`shelf_static` is a `Handler` for the Dart `shelf` package.
45

56
### Example
67
```dart

pkgs/shelf_test_handler/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![pub package](https://img.shields.io/pub/v/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_test_handler.svg)](https://pub.dev/packages/shelf_test_handler/publisher)
3+
14
A [shelf][] handler that makes it easy to test HTTP interactions, especially
25
when multiple different HTTP requests are expected in a particular sequence.
36

pkgs/shelf_web_socket/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![pub package](https://img.shields.io/pub/v/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket)
2+
[![package publisher](https://img.shields.io/pub/publisher/shelf_web_socket.svg)](https://pub.dev/packages/shelf_web_socket/publisher)
3+
14
## Web Socket Handler for Shelf
25

36
`shelf_web_socket` is a [Shelf][] handler for establishing [WebSocket][]

0 commit comments

Comments
 (0)