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

Any documentation please #119

Closed
santiagoalmeidabolannos opened this issue Sep 6, 2019 · 7 comments
Closed

Any documentation please #119

santiagoalmeidabolannos opened this issue Sep 6, 2019 · 7 comments
Assignees
Labels
enhancement New feature or request

Comments

@santiagoalmeidabolannos
Copy link

Please can you add some examples? I am interested on add reminders in the calendar. Thanks

@saurabh-mhaisekar
Copy link

Please add some documentation

@MaikuB
Copy link
Contributor

MaikuB commented Nov 10, 2019

There's an example app in the repo https://github.com/builttoroam/flutter_plugins/tree/master/device_calendar/example. FYI, it's pretty standard that plugins have an example app at a location like that relative to the plugin as it's comes out of the box with the template for creating a plugin

@saurabh-mhaisekar
Copy link

Yes there is an example app and yes there is standard procedure to add a example. But when i'm writing code for project i would rather look up API reference rather than hunting into example code what functionality of code is.

@MaikuB
Copy link
Contributor

MaikuB commented Nov 12, 2019

To clarify, my reply was in relation to the original poster who asked about examples.

API reference documentation for plugins are on pub. See https://pub.dev/documentation/device_calendar/latest/device_calendar/device_calendar-library.html. PRs are welcome for where you feel there are gaps

@bhl09 bhl09 self-assigned this Jan 21, 2020
@bhl09 bhl09 added the enhancement New feature or request label Jan 21, 2020
@bhl09
Copy link
Contributor

bhl09 commented Jan 22, 2020

Just an update: I have added some examples and links into the example readme. You can check it out on develop branch for now.
Quick link: https://github.com/builttoroam/flutter_plugins/blob/develop/device_calendar/example/README.md

@bhl09
Copy link
Contributor

bhl09 commented Mar 25, 2020

Documentation has been updated and published in pub.dev here - Examples are not shown correctly at the moment.

Examples are available in the repo here.

I'll fix to show the examples in the pub.dev site and add more examples in the future.

@bhl09 bhl09 closed this as completed Mar 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants