Skip to content

Commit

Permalink
docs: add links to docs on readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
renancaraujo committed Aug 30, 2023
1 parent bb0c751 commit b62d36f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ For official documentation, please visit https://dartfrog.vgv.dev.
| [dart_frog_gen](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_gen) | [![pub package](https://img.shields.io/pub/v/dart_frog_gen.svg)](https://pub.dev/packages/dart_frog_gen) |
| [dart_frog_cli](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_cli) | [![pub package](https://img.shields.io/pub/v/dart_frog_cli.svg)](https://pub.dev/packages/dart_frog_cli) |
| [dart_frog_web_socket](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_web_socket) | [![pub package](https://img.shields.io/pub/v/dart_frog_web_socket.svg)](https://pub.dev/packages/dart_frog_web_socket) |
| [dart_frog_auth](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_auth) | [![pub package](https://img.shields.io/pub/v/dart_frog_auth.svg)](https://pub.dev/packages/dart_frog_auth) |


## Quick Start 🚀

Expand Down
4 changes: 4 additions & 0 deletions packages/dart_frog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ A fast, minimalistic backend framework for Dart 🎯

Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄

## Documentation 📝

For official documentation, please visit https://dartfrog.vgv.dev.

## Quick Start 🚀

### Prerequisites 📝
Expand Down
2 changes: 2 additions & 0 deletions packages/dart_frog_cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Available commands:
Run "dart_frog help <command>" for more information about a command.
```

Learn more about it on the [official docs](https://dartfrog.vgv.dev/docs/overview).

[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml/badge.svg?branch=main
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml
[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog_cli/coverage_badge.svg
Expand Down
2 changes: 2 additions & 0 deletions packages/dart_frog_web_socket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ WebSocket support for [Dart Frog][dart_frog_link].

Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄

Learn more about it on the [official docs](https://dartfrog.vgv.dev/docs/advanced/web_socket).

## Quick Start 🚀

Use `webSocketHandler` to manage `WebSocket` connections in a Dart Frog route handler.
Expand Down

0 comments on commit b62d36f

Please sign in to comment.