Implement pub recommendations (#50)

getsentry · Dec 11, 2019 · 545ce93 · 545ce93
1 parent 1321244
commit 545ce93
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,12 @@
 # package:sentry changelog
 
+## 3.0.0+1
+
+- `pubspec.yaml` and example code clean-up.
+
 ## 3.0.0
 
-- Support Web 
+- Support Web
   - `SentryClient` from `package:sentry/sentry.dart` with conditional import
   - `SentryBrowserClient` for web from `package:sentry/browser_client.dart`
   - `SentryIOClient` for VM and Flutter from `package:sentry/io_client.dart`

diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,12 @@
+# `package:sentry` example
+
+The example in this directory throws an error and sends it to Sentry.io. Use it
+as a source of example code, or to smoke-test your Sentry.io configuration.
+
+To use the example, create a Sentry.io account and get a DSN for your project.
+Then run the following command, replacing "{DSN}" with the one you got from
+Sentry.io:
+
+```
+dart example/main.dart {DSN}
+```
diff --git a/bin/test.dart → example/main.dart b/bin/test.dart → example/main.dart
diff --git a/lib/src/version.dart b/lib/src/version.dart
@@ -9,7 +9,7 @@
 library version;
 
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '3.0.0';
+const String sdkVersion = '3.0.0+1';
 
 /// The SDK name reported to Sentry.io in the submitted events.
 const String sdkName = 'dart';

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,7 +1,8 @@
 name: sentry
-version: 3.0.0
-description: A pure Dart Sentry.io client.
-author: Flutter Authors <flutter-dev@googlegroups.com>
+version: 3.0.0+1
+description: >
+  A crash reporting library for for Dart that sends crash reports to Sentry.io.
+  This library supports Dart VM, and Flutter for mobile, web, and desktop.
 homepage: https://github.com/flutter/sentry
 
 environment: