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

Add badge for usage examples for this module on Codota #467

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

drorweiss
Copy link

This simple PR just adds a shield that links to usage examples for tape on Codota, as available on GitHub. It is possible to get examples for each individual method as listed on the right-hand side of the linked web page. I believe this will be valuable for new users who want to learn to use this module by examining examples from other projects.
Feedback welcome. If you like it, I can also link to examples for individual methods in the readme in a separate PR.

Here's a screenshot of how the change looks when viewing this readme markdown:
image

@ljharb
Copy link
Collaborator

ljharb commented May 6, 2019

What is codota? As the maintainer of tape, do I have the ability to edit, delete, and alter the ordering of existing examples that show up?

@drorweiss
Copy link
Author

drorweiss commented May 6, 2019

Codota is a startup that analyzes open source repositories in order to make it easier for developers to use libraries correctly, based on collective knowledge. Yes, we're working on the ability to let maintainers control the examples for their libraries - happy to discuss it with you.

@ljharb
Copy link
Collaborator

ljharb commented May 6, 2019

Have the owners of those repositories granted explicit permission for their content to be used in this manner? I'm not interested in endorsing a site that silently copies and redisplays content without the permission of the creators (licensing and public availability not withstanding).

@drorweiss
Copy link
Author

Codota does not silently copy content. On the contrary - it provides attribution and links to the original content.

@ljharb
Copy link
Collaborator

ljharb commented May 7, 2019

Attribution is important, but isn't the same thing as a notification and opt in mechanism - ie, where you don't display the content from my repos until after I've given explicit permission.

@drorweiss
Copy link
Author

OK, I'm messaging you privately on Twitter to continue this discussion

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

Successfully merging this pull request may close these issues.

2 participants