Awesome. I typically include a demo folder with inside my plugin repos, but this does mean that this demo code gets copied all over the place if a user installs a plugin via git-repo or clone. I npm-ignore the demo folder so at least it does not go to npm ...
Here's an example: https://github.com/purplecabbage/phonegap-plugin-sidebar/ We could also create a cordova-demos repo in apache which has a demo project for each core plugin. Cheers, Jesse @purplecabbage risingj.com On Mon, Mar 28, 2016 at 4:26 PM, Robert Posener <rposen...@gmail.com> wrote: > +500 > > Regards > *Rob Posener* > 0419 012 627 > > On 29 March 2016 at 08:47, Parashuram N <panar...@microsoft.com> wrote: > > > Hey folks, > > > > At the moment, the sample code in our plugins is limited to only show > > basic usage of the API. While this is great for someone who has already > > written Cordova projects, I believe that we may need more examples for > > folks who are just getting started with Cordova. > > To improve our documentation, Norm has sent out a pull request with > > additional examples that show the typical use cases for the plugins - > > https://github.com/apache/cordova-plugin-geolocation/pull/74/files > > > > This PR is the first in a set of work that we would like to do, to > improve > > documentation for plugins. A few questions to the community about this > > direction > > > > > > 1. Is it ok to include this as a part of the README ? That would > > increase the visibility of the examples much more. We could have a > > "REFERENCE" section that is for quick reference, and then this set of > > detailed examples showing how the plugins work. Anyone have objections to > > that ? Note that the README would be longer, but I think that should be > ok. > > Also note that the README is imported into the Cordova docs, so these > > examples will also show up there > > > > 2. Some of the example have links to full projects that use the > > plugin. We did not find a place on the Apache github organization to put > it > > all up, so they currently reside in a Microsoft-github organization. Is > > that ok ? Is there a place to put full fledged Cordova samples on the > > Apache repos ? > > >
