You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by Richard Knoll <ri...@microsoft.com> on 2016/04/01 02:26:38 UTC

RE: Adding Examples for Plugins in the ReadMe

Hey everyone,

Norm redid the PR to temporarily remove the links to the full sample apps until we figure out where to put them [1]. I'm going to go ahead and merge the rest of his changes unless anyone objects. For those interested, he's also done some samples for inAppBrowser [2].

Thanks,
Richard

[1] https://github.com/apache/cordova-plugin-geolocation/pull/75
[2] https://github.com/apache/cordova-plugin-inappbrowser/pull/161

-----Original Message-----
From: Jesse [mailto:purplecabbage@gmail.com] 
Sent: Wednesday, March 30, 2016 9:44 AM
To: dev@cordova.apache.org
Subject: Re: Adding Examples for Plugins in the ReadMe

Currently, 'Cordova plugin add local/path' will copy the entire contents of local/path to currentApp/plugins/new-plugin

This is only true of local git clones and installs via githuburls.  Npm installs should use .npmignore to exclude demo code inclusion. 
We should eventually make plugin install honor the text of .npmignore or add an <exclude> tag to plugin.xml

> On Mar 30, 2016, at 7:10 AM, Alexis Kofman <al...@gmail.com> wrote:
> 
> Hello all,
> 
> +1 also.
> 
> In my case I've added demo apps from the manual tests of my plugins. I 
> thought it was a good location to permit users to easily "test" plugins.
> @purplecabbage, even if you have a demo folder in your plugins, it is 
> just dowloaded by github users but not installed in their project so 
> it is not really a big deal right ?
> 
> On Wed, Mar 30, 2016 at 3:57 PM, Raymond Camden 
> <ra...@gmail.com>
> wrote:
> 
>> Huge +1. This is an incredibly good idea.
>> 
>> On Mon, Mar 28, 2016 at 4:47 PM, Parashuram N 
>> <pa...@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
>> 
>> 
>> 
>> 
>> --
>> =====================================================================
>> ====== Raymond Camden, Developer Advocate for StrongLoop at IBM
>> 
>> Email : raymondcamden@gmail.com
>> Blog : 
>> https://na01.safelinks.protection.outlook.com/?url=www.raymondcamden.
>> com&data=01%7c01%7criknoll%40microsoft.com%7c52c104aee72540bbb21708d3
>> 58ba8447%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=mLXdDIRdrXiSZaJ
>> ILzz9brWK7pkDmD%2bQ1Qrfbcc4fe8%3d
>> Twitter: raymondcamden
>> 
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
>> For additional commands, e-mail: dev-help@cordova.apache.org
> 
> 
> --
> Alexis Kofman

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org