Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated for license information

  • Loading branch information...
commit 3af50e8ca609aa1228e97f20edc142b1edd3cc8b 1 parent fe19353
@benjaminplee authored
Showing with 45 additions and 39 deletions.
  1. +32 −0 README.md
  2. +4 −1 index.html
  3. +5 −1 index.js
  4. +4 −0 plan.js
  5. +0 −37 readme.txt
View
32 README.md
@@ -0,0 +1,32 @@
+# plan.js #
+
+Simple plan (workflow) creation utility library. Aim is to simplify simple workflows such as modals with forms and ajax error handling.
+
+A live example can be found on this repo's [GitHub Pages site](http://benjaminplee.github.com/PlanJS/).
+
+## Features / Goals
+
+* Should handle sync and async steps
+* Should have minimal plan setup ceremony
+* Should handle steps w/ 1 or 2 possible outcomes
+* Should allow for information to be passed between steps
+* Should allow for plan execution to pass in config/context data
+* Should allow for creation of plans and seperate execution; possibly multiple times w/ different context
+* Should minimally polute global namespace
+
+## Wish List / Thoughts
+
+- Cleanup all of the args prepending
+- Find a better way to handline context and streamline data passing without using all of the arguments or jump through 'this' hoops
+- make take_step and take_future_step not prototype methods and maybe more general
+- cleaner way for actions to denote success/failure than explicit knowledge of jquery deferred
+- remove dependency on jquery and manage own callback list and resolution with custom deferred that meets the specific needs of this lib and not the general ones of jquery (although common naming is nice for documentation and prior knowledge)
+- maybe configure properties on action functions themselves which denote if the function needs the deferred, args, or context objects? only make available if specifically requested?
+
+## License
+
+<a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">
+ <img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by/3.0/88x31.png" />
+</a>
+<br />
+<span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">Plan.JS</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/benjaminplee/PlanJS" property="cc:attributionName" rel="cc:attributionURL">Benjamin P Lee</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">Creative Commons Attribution 3.0 Unported License</a>.
View
5 index.html
@@ -5,7 +5,10 @@
<title>Plan.js Example</title>
</head>
<body>
- <center><button style="height:200px; width:200px" id="the_button">Click Me!</button></center>
+ <center>
+ <h1>Example Usage LOL</h1>
+ <button style="height:200px; width:200px" id="the_button">Click Me!</button>
+ </center>
<a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">Plan.JS</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/benjaminplee/PlanJS" property="cc:attributionName" rel="cc:attributionURL">Benjamin P Lee</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">Creative Commons Attribution 3.0 Unported License</a>.
View
6 index.js
@@ -1,3 +1,7 @@
+// Plan.JS
+// Author: Benjamin P Lee
+// License: Creative Commons Attribution 3.0 Unported License (see source README)
+
function hai(deferred, name) {
confirm("hai want 2 play? my name is " + name) ? deferred.resolve() : deferred.reject();
}
@@ -42,4 +46,4 @@ var lol_plan = new PlanJS({
var the_button = document.getElementById("the_button");
the_button.onclick = function() {
lol_plan.execute("ben");
-};
+};
View
4 plan.js
@@ -1,3 +1,7 @@
+// Plan.JS
+// Author: Benjamin P Lee
+// License: Creative Commons Attribution 3.0 Unported License (see source README)
+
var PlanJS = (function() {
function PlanConstructor(details) {
this.steps = details.steps;
View
37 readme.txt
@@ -1,37 +0,0 @@
-plan.js
-
-Simple plan (workflow) creation utility.
-
-Aim is to simplify simple workflows such as modals with forms and error handling.
-
-Live example: http://benjaminplee.github.com/PlanJS/
-
-[X] Should handle sync and async steps
-[X] Should have minimal plan setup ceremony
-[X] Should handle steps w/ 1 or 2 possible outcomes
-[X] Should allow for information to be passed between steps
-[X] Should allow for plan execution to pass in config/context data
-[X] Should allow for creation of plans and seperate execution
- possibly multiple times w/ different context
-[X] Should minimally polute global namespace
-
-Wish List:
-
-[ ] Cleanup all of the args prepending
-[ ] Find a better way to handline context and streamline data passing
-without using all of the arguments or jump through 'this' hoops
-[ ] make take_step and take_future_step not prototype methods and
-maybe more general
-[ ] cleaner way for actions to denote success/failure than explicit
-knowledge of jquery deferred
-[ ] remove dependency on jquery and manage own callback list and
-resolution with custom deferred that meets the specific needs of this
-lib and not the general ones of jquery (although common naming is nice
-for documentation and prior knowledge)
-[ ] maybe configure properties on action functions themselves which
-denote if the function needs the deferred, args, or context objects?
-only make available if specifically requested?
-
-License:
-
-<a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">Plan.JS</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/benjaminplee/PlanJS" property="cc:attributionName" rel="cc:attributionURL">Benjamin P Lee</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/deed.en_US">Creative Commons Attribution 3.0 Unported License</a>.
Please sign in to comment.
Something went wrong with that request. Please try again.