Skip to content

Commit ede8f59

Browse files
felangelfelangel
committed
docs: update package READMEs
1 parent 0935704 commit ede8f59

File tree

4 files changed

+92
-9
lines changed

4 files changed

+92
-9
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[![Dart Frog Logo][logo_white]][dart_frog_link_dark]
22
[![Dart Frog Logo][logo_black]][dart_frog_link_light]
33

4-
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
5-
64
[![ci][ci_badge]][ci_link]
75
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
86
[![License: MIT][license_badge]][license_link]
97

10-
A fast, minimalistic backend framework for Dart.
8+
A fast, minimalistic web framework for Dart 🎯
9+
10+
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
1111

1212
## Quick Start 🚀
1313

‎packages/dart_frog/README.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,69 @@
11
# Dart Frog
22

3+
[![Dart Frog Logo][logo_white]][dart_frog_link_dark]
4+
[![Dart Frog Logo][logo_black]][dart_frog_link_light]
5+
6+
[![ci][ci_badge]][ci_link]
37
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
48
[![License: MIT][license_badge]][license_link]
59

6-
A fast, minimalistic web framework for Dart
10+
A fast, minimalistic web framework for Dart 🎯
11+
12+
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
13+
14+
## Quick Start 🚀
15+
16+
### Prerequisites 📝
17+
18+
In order to use Dart Frog you must have the [Dart SDK][dart_installation_link] installed on your machine.
19+
20+
### Installing 🧑‍💻
21+
22+
```sh
23+
# 📦 Install the dart_frog cli from source
24+
dart pub global activate dart_frog_cli
25+
```
26+
27+
### Creating a Project ✨
28+
29+
Use the `dart_frog create` command to create a new project.
30+
31+
```sh
32+
# 🚀 Create a new project called "my_project"
33+
dart_frog create my_project
34+
```
35+
36+
### Start the Dev Server 🏁
37+
38+
Next, open the newly created project and start the dev server via:
39+
40+
```sh
41+
# 🏁 Start the dev server
42+
dart_frog dev
43+
```
44+
45+
### Create a Production Build 📦
46+
47+
Create a production build which includes a `DockerFile` so that you can deploy anywhere:
48+
49+
```sh
50+
# 📦 Create a production build
51+
dart_frog build
52+
```
53+
54+
## Documentation 📝
55+
56+
View the full documentation [here][documentation_link].
757

58+
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml/badge.svg
59+
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml
60+
[dart_frog_link_dark]: https://github.com/verygoodopensource/dart_frog#gh-dark-mode-only
61+
[dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog#gh-light-mode-only
62+
[documentation_link]: https://github.com/VeryGoodOpenSource/dart_frog/blob/main/README.md#documentation-
863
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
964
[license_link]: https://opensource.org/licenses/MIT
65+
[logo_black]: ../../assets/dart_frog_logo_black.png#gh-light-mode-only
66+
[logo_white]: ../../assets/dart_frog_logo_white.png#gh-dark-mode-only
1067
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
1168
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
69+
[very_good_ventures_link]: https://verygood.ventures

‎packages/dart_frog_cli/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
# Dart Frog CLI
1+
[![Dart Frog Logo][logo_white]][dart_frog_link_dark]
2+
[![Dart Frog Logo][logo_black]][dart_frog_link_light]
23

4+
[![ci][ci_badge]][ci_link]
35
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
46
[![License: MIT][license_badge]][license_link]
57

6-
The official command line interface for dart_frog.
8+
The official command line interface for [Dart Frog][dart_frog_link].
9+
10+
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
711

812
```
913
A fast, minimalistic backend framework for Dart.
@@ -15,13 +19,22 @@ Global options:
1519
--version Print the current version.
1620
1721
Available commands:
22+
build Create a production build.
1823
create Creates a new Dart Frog app.
1924
dev Run a local development server.
2025
2126
Run "dart_frog help <command>" for more information about a command.
2227
```
2328

29+
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml/badge.svg
30+
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog_cli.yaml
31+
[dart_frog_link]: https://github.com/verygoodopensource/dart_frog
32+
[dart_frog_link_dark]: https://github.com/verygoodopensource/dart_frog#gh-dark-mode-only
33+
[dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog#gh-light-mode-only
2434
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
2535
[license_link]: https://opensource.org/licenses/MIT
36+
[logo_black]: ../../assets/dart_frog_logo_black.png#gh-light-mode-only
37+
[logo_white]: ../../assets/dart_frog_logo_white.png#gh-dark-mode-only
2638
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
2739
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
40+
[very_good_ventures_link]: https://verygood.ventures

‎packages/dart_frog_gen/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
1-
# dart_frog_gen
1+
[![Dart Frog Logo][logo_white]][dart_frog_link_dark]
2+
[![Dart Frog Logo][logo_black]][dart_frog_link_light]
23

4+
[![ci][ci_badge]][ci_link]
35
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
46
[![License: MIT][license_badge]][license_link]
57

6-
Code generation tooling for dart_frog
8+
Code generation tooling for [Dart Frog][dart_frog_link].
79

10+
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
11+
12+
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml/badge.svg
13+
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml
14+
[dart_frog_link]: https://github.com/verygoodopensource/dart_frog
15+
[dart_frog_link_dark]: https://github.com/verygoodopensource/dart_frog#gh-dark-mode-only
16+
[dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog#gh-light-mode-only
817
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
918
[license_link]: https://opensource.org/licenses/MIT
19+
[logo_black]: ../../assets/dart_frog_logo_black.png#gh-light-mode-only
20+
[logo_white]: ../../assets/dart_frog_logo_white.png#gh-dark-mode-only
1021
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
11-
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
22+
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
23+
[very_good_ventures_link]: https://verygood.ventures

0 commit comments

Comments
 (0)