Skip to content
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.

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

Documentation clarification #67

Open
milesegan opened this issue Dec 1, 2024 · 0 comments
Open

Documentation clarification #67

milesegan opened this issue Dec 1, 2024 · 0 comments

Comments

@milesegan
Copy link

The usage example in the README calls the API this way:

void main() async {
  // Must add this line.
  WidgetsFlutterBinding.ensureInitialized();

  String feedURL = 'http://localhost:5002/appcast.xml';
  await autoUpdater.setFeedURL(feedURL);
  await autoUpdater.checkForUpdates();
  await autoUpdater.setScheduledCheckInterval(3600);

  runApp(MyApp());
}

But reading through the docs and the code it looks like the only thing actually necessary to enable the autoUpdater is this:

String feedURL = 'http://localhost:5002/appcast.xml';
await autoUpdater.setFeedURL(feedURL);

Calling checkForUpdates or setScheduledCheckInterval is not necessary for a basic working setup. Is that correct? If so maybe the docs could be expanded to make this more clear?

I'm happy to make a PR if this is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant