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 "How do I add a behavior?" and "How do I add an interface?" sections to README #11

Open
jywarren opened this issue Jun 5, 2017 · 4 comments

Comments

@jywarren
Copy link
Member

jywarren commented Jun 5, 2017

No description provided.

@ryzokuken
Copy link
Member

This one sounds really good. One little confusion though. Would this be regarding people contributing stuff (actually coding a new interface, etc)? or regarding people making suggestions?

@jywarren
Copy link
Member Author

jywarren commented Jun 5, 2017 via email

@jywarren
Copy link
Member Author

jywarren commented Jun 6, 2017

This would also be a good place to outline the API for behaviors and the API for interfaces. You could show a very simple example interface and what is the minimum required methods or properties and interface needs to work. This will both make it easier for people to read your code, and will make it easier for them to write code that properly integrates with your expected API.

@jywarren
Copy link
Member Author

jywarren commented Jun 6, 2017

I think the publiclab.editor Library does something like this in order to show how to write a new module for the editor. Each module for the editor requires, for example, a .value() method.

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

No branches or pull requests

2 participants