Skip to content
This repository has been archived by the owner on Nov 5, 2019. It is now read-only.

docs(README): add example #45

Closed
wants to merge 2 commits into from
Closed

docs(README): add example #45

wants to merge 2 commits into from

Conversation

tiberiucorbu
Copy link

Regarding #44 here is my attempt to improve the doc and provide an useful example

@jsf-clabot
Copy link

jsf-clabot commented Oct 10, 2017

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Tiberiu Corbu seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.

@tiberiucorbu
Copy link
Author

Does the example look OK ? Should I improve it somehow ?

@alexander-akait
Copy link
Member

@tiberiucorbu please accept CLA

@michael-ciniawsky michael-ciniawsky changed the title Add example docs(README): add example Sep 12, 2018
@@ -49,6 +52,10 @@ module.exports = {
import exec from 'script-loader!./script.js';
```

### Example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<h2 align="center">Examples</h2>

@@ -49,6 +52,10 @@ module.exports = {
import exec from 'script-loader!./script.js';
```

### Example

Take a look at the example provided in the [./example](example) folder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a small example(s) directly to the README here

@@ -0,0 +1,37 @@
# Script loader example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sry, but we try to avoid adding (new) example/ to repos directly as they tend to be getting outdated and nobody is normally willing to maintain them. Please add a small example to the README instead (as mentiond above) and remove the example/ folder

@michael-ciniawsky
Copy link
Member

@tiberiucorbu Please sign the CLA. Otherwise I'm going to close this PR within the next 48-72 hours due to the missing CLA signment

@michael-ciniawsky
Copy link
Member

michael-ciniawsky commented Sep 26, 2018

#45 (comment)

I'm closing this due to inactivity for now, feel free to reopen if the comments are addressed and the CLA is signed. Thx

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

Successfully merging this pull request may close these issues.

4 participants