add note about .on() changes to come

djanowski · Feb 12, 2012 · f42d1f3 · f42d1f3
1 parent 88cebe0
commit f42d1f3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -238,7 +238,7 @@ Here's the run down of the method alias' added...
 
 **ADD EVENTS**
 
- + on - <code>$(element).on('click', fn);</code>
+ + on - <code>$(element).on('click', fn);</code> *NOTE: This API is likely to change slightly in the near future see [#55](https://github.com/fat/bean/issues/55)*
  + addListener - <code>$(element).addListener('click', fn);</code>
  + bind - <code>$(element).bind('click', fn);</code>
  + listen - <code>$(element).listen('click', fn);</code>

diff --git a/src/ender.js b/src/ender.js
@@ -17,7 +17,7 @@
     , fire = integrate('fire')
 
     , methods = {
-          on: add
+          on: add // NOTE: .on() is likely to change in the near future, don't rely on this as-is see https://github.com/fat/bean/issues/55
         , addListener: add
         , bind: add
         , listen: add