Nice project and addon! I would suggest to add a bit more of documentation since it can be hard to follow if you are a beginner, specially if you are trying to implement this on an existing project instead of building upon it.
