Repository navigation
docs: restructure the README for the ably_pubsub_device package - #25
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the README for the 0.3.0
ably_pubsub_devicepackage to match the other Ably Pub/Sub2.0 READMEs: an overview modelled on the Go README, two-sentence requirements and the migration
table after the quick start. Only
README.mdchanges.What changed
ably_pubsub_deviceandcreateClient.dart:io.dart pub add ably_pubsub_device, orflutter pub addin Flutter apps.authUrlsample.authCallbackis one sentence.How it was validated
main:createClient,ClientOptions, theAuthCallbackreturn types,LogLevel,pubspec.yamland UPGRADING.md.dart analyzein a scratch package. A web build fails as documented.main.Risk Assessment