kiwi-bop / flutter_crashlytics

:package: Flutter plugin for Crashlytics integration
BSD 2-Clause "Simplified" License
194 stars 46 forks source link

ReadMe is incomplete & confusing #60

Open gitmoto opened 5 years ago

gitmoto commented 5 years ago

I found the ReadMe.md file to be very confusing. Here are some of the issues with it:

  1. Fabric & Firebase instructions are intermingled. Consider having 2 separate installation sections. One for Fabric & one for Firebase
  2. What does this mean? Where does it go? Just run this in a terminal? "And apply the fabric plugin apply plugin: 'io.fabric'"
  3. Does this instruction apply to ALL of the iOS instructions? Or just the top part? "On iOS side your need to set your Fabric ID under your Info.plist like: (Only do this if using Fabric, not Firebase as you will not have an Api Key)"
  4. In the Flutter implementation instructions, it says this "Your main method should look like:" but it doesn't say anything about including this import statement: "import "dart:async";" I had to find it by googling to figure out what Zone meant
jmrboosties commented 5 years ago

I'm still a bit unclear on how the run script step should work. I get the part where we add the input file, but the entry below shell is a bit unclear. In the example, he has a screenshot of $(PODS_ROOT)/Fabric/Run, followed by a hash. My Flutter project defaulted this value to

/bin/sh "$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build

Just a bit unclear on if that goes before/after or what.

tomk9 commented 5 years ago

I'm still a bit unclear on how the run script step should work. I get the part where we add the input file, but the entry below shell is a bit unclear. In the example, he has a screenshot of $(PODS_ROOT)/Fabric/Run, followed by a hash. My Flutter project defaulted this value to

/bin/sh "$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build

Just a bit unclear on if that goes before/after or what.

You should follow official Firebase instruction https://firebase.google.com/docs/crashlytics/get-started?authuser=0#initialize The most important step is Click + Add a new build phase, then select New Run Script Phase.