-
Notifications
You must be signed in to change notification settings - Fork 0
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
Docs in the README #1
Comments
Hi, yes sure I'll add ASAP; the problem is that current features (that I need to better describe in a CHANGELOG) are to create CloudEvent instances and check/validate them (there are some examples in unit tests but I agree that I need to improve). |
@mcollina Hi Matteo, I should be able to publish first release in a few days now ... do you think updated example (in the README and now even in a Node.js script in a dedicated 'example' folder) could be good enough to describe simple usage of this library ? |
This is not really clear, the example needs to be cleared up, and I would add some more API docs. One note: it's better to use option objects instead of positional arguments. |
Ok, I'll do more cleanup ... but on the more API docs currently there isn't so much exposed by CloudEvent class so can't show more, but of course if you have some idea tell me, I'll be happy to improve it :-) . |
More info/cleanup in the README (and no more exclude the 'example' folder in the npm package), and first release (0.1.0) just published, I hope things are a little more clear now. |
Can you add some docs in the README? It's not really clear how to use this.
The text was updated successfully, but these errors were encountered: