Commits

Joris Kluivers committed 8cd7d49

Added usage to Readme

  • Participants
  • Parent commits 88de5d6

Comments (0)

Files changed (1)

 - Read my weblog at [http://joris.kluivers.nl](http://joris.kluivers.nl)
 - Follow [@kluivers on Twitter](http://twitter.com/kluivers)
 
-# Generator project
+## Usage
+
+Each function has the signature of the form:
+
+```
+CGFloat JKInterpolation(CGFloat  time, CGFloat start, CGFloat end);
+```
+
+- **time**: the interpolation progress in range of 0.0 to 1.0
+- **start**: the initial value for time=0.0
+- **end**: the resulting value for time=1.0
+
+## Generator project
 
 The Generator utility generates a JSON output with interpolations for each of the functions, to be shown in a graph like: