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 should include plot.init and other "Getting Started" examples. #8

Closed
adamjaffeback opened this issue Jan 9, 2016 · 3 comments

Comments

@adamjaffeback
Copy link

The Phonegap integration website does an ok step-by-step of how to use the plugin, but it's not quite a "Hello World" example. It makes use of the plot.init function, but doesn't say why it's used and it's not documented in this README.

I think it would be most helpful to a new user, testing out Plot for the first time, if the README were ordered as a step-by-step, instead of having to navigate to an outside page. I'm happy to submit a draft these changes as a PR if requested.

I'm also happy to contribute an Ionic (Angular on top of Cordova) example.

@markvandertol
Copy link
Contributor

Hi, thank you for your suggestion. This is indeed something that could be improved.

All the integration guides are currently on our website, which is for the time being not something we would like to change. We could improve on this by letting the link to the integration guide stand out more.

@markvandertol
Copy link
Contributor

We will extend the documentation in the near future to better explain how to get started and what properties can be passed to plot.init. Also we'll add a section about Ionic.

Other parts of the method reference are already expanded to explain more about the callbacks.

@markvandertol
Copy link
Contributor

A better integration guide has been added under Integration Guide that shows how to get started. Also the plot.init method is now documented.

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

2 participants