search

ibm-dev-incubator / demoparser

Apache License 2.0
34 stars 10 forks source link

Need documentation #9

Open T1MOXA opened 5 years ago

T1MOXA commented 5 years ago

I cannot use your library, there is a lack of documentation and examples of implementation. I have to study all the source code to understand how to implement a particular function. Will there be normal documentation, and if so when ?

rmoe commented 5 years ago

All I have right now is here: https://ibm-dev-incubator.github.io/demoparser/. It's a list of all of the events with a brief explanation. It also has the auto-generated API docs. I don't have a lot of time to work on this but I could add some more example code. Are there particular examples that you think would be helpful to have?

T1MOXA commented 5 years ago

Cool, why isn't it listed anywhere ? Or I am blind ?

Can't say what is missing... At the moment I do not quite understand how you can find out when someone is observing. By the way, one of those examples that is present not working example which allows you to get messages from the chat