Skip to content

add some clarification to the top-level readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2023
Merged

add some clarification to the top-level readme #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

## Overview

This repository is home to tooling related Dart packages.
This repository is home to tooling related Dart packages. Generally, this means
packages published through the
[tools.dart.dev](https://pub.dev/publishers/tools.dart.dev) publisher that
don't naturally belong to other topic monorepos (like
[dart-lang/build](https://github.com/dart-lang/build),
[dart-lang/test](https://github.com/dart-lang/test), or
[dart-lang/shelf](https://github.com/dart-lang/shelf)).

## Packages

Expand Down
15 changes: 9 additions & 6 deletions pkgs/dash_analytics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
[![package:dash_analytics](https://github.com/dart-lang/tools/actions/workflows/dash_analytics.yml/badge.svg)](https://github.com/dart-lang/tools/actions/workflows/dash_analytics.yml)

## What's This?
## What's this?

This package is intended to be used on Dash (Flutter, Dart, etc.) related tooling only.
It provides APIs to send events to Google Analytics using the Measurement Protocol.
This package is intended to be used on Dash (Flutter, Dart, etc.) related
tooling only. It provides APIs to send events to Google Analytics using the
Measurement Protocol.

This is not intended to be general purpose or consumed by the community. It is responsible for toggling analytics collection for Dash related tooling on each developer's machine.
This is not intended to be general purpose or consumed by the community. It is
responsible for toggling analytics collection for Dash related tooling on each
developer's machine.

## Using This Package As A Dash Tool
## Using this package

Refer to the [guide](USAGE_GUIDE.md).
Refer to the [usage guide](USAGE_GUIDE.md).