Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update README.md

  • Loading branch information...
commit dae30d0436241e8d72983d0e05cfa9bb0108f696 1 parent e5f17df
authored January 06, 2012

Showing 1 changed file with 54 additions and 0 deletions. Show diff stats Hide diff stats

  1. 54  README.md
54  README.md
Source Rendered
... ...
@@ -0,0 +1,54 @@
  1
+# Overview
  2
+
  3
+Spring Web Flow facilitates building web applications that require guided navigation -- e.g. a shopping cart, flight check-in, a loan application, and many others. In contrast to stateless, free-form navigation such use cases have a clear start and end point, one or more screens to go through in a specific order, and a set of changes that are not finalized to the end.
  4
+
  5
+A distinguishing feature is the ability to define a **flow definition** consisting of *states*, *transitions*, and *data*. For example, view states correspond to the individual screens of the flow while transitions are caused by events resulting from the click of a button or a link. Data may be stored in scopes such as *flash*, *view*, *flow*, and others. Scoped data is cleared when it is no longer in scope.
  6
+
  7
+In REST terms a flow represents as a single resource. The same URL used to start the flow is also the URL used to step through the flow (there is also an execution key uniquely identifying the current flow instance). As a result of this approach navigation remains encapsulated in the flow definition.
  8
+
  9
+Some key benefits of using Spring Web Flow:
  10
+
  11
++ A flow abstraction to model *"long conversations"* in web applications
  12
++ Proper encapsulation for navigation rules
  13
++ Multiple scopes in which to keep data
  14
++ Automatic use of the POST/REDIRECT/GET pattern to avoid browser warnings
  15
++ Impossible to return to completed flow sessions via browser back button
  16
++ Rapid prototyping of flow requirements
  17
++ Development mode in which flow definition changes are detected on the fly
  18
++ IDE visualization for flow definitions
  19
++ Much more...
  20
+
  21
+# Documentation
  22
+
  23
+See the current [Javadoc](http://static.springsource.org/spring-webflow/docs/current/javadoc-api/) and [Reference](http://static.springsource.org/spring-webflow/docs/current/spring-webflow-reference/) docs.
  24
+
  25
+# Samples
  26
+
  27
+The `spring-webflow-samples` sub-directory contains several samples that can be built with Maven. More samples can be found in the [spring-samples](https://src.springframework.org/svn/spring-samples) SVN repository: see [webflow-showcase](https://src.springframework.org/svn/spring-samples/webflow-showcase) and [webflow-primefaces-showcase](https://src.springframework.org/svn/spring-samples/webflow-primefaces-showcase).
  28
+
  29
+# Downloading artifacts
  30
+
  31
+Instructions on [downloading Spring Web Flow](https://github.com/SpringSource/spring-webflow/wiki/Downloading-Spring-Web-Flow-Artifacts) artifacts via Maven and other build systems are available via the project wiki.
  32
+
  33
+# Issue Tracking
  34
+
  35
+Spring Web Flow's JIRA issue tracker can be found [here](http://jira.springsource.org/browse/SWF). If you think you've found a bug, please consider helping to reproduce it by submitting an issue reproduction project via the [spring-webflow-issues](https://github.com/springsource/spring-webflow-issues) repository. The [readme](https://github.com/springsource/spring-webflow-issues#readme) provides simple step-by-step instructions.
  36
+
  37
+# Getting support
  38
+
  39
+Check out the [Spring forums](http://forum.springsource.org/forumdisplay.php?36-Web-Flow) and the [spring-webflow tag](http://stackoverflow.com/questions/tagged/spring-webflow) on StackOverflow. [Commercial support](http://springsource.com/support/springsupport) is available too.
  40
+
  41
+# Building from source
  42
+
  43
+Instructions on [building Spring Web Flow](https://github.com/SpringSource/spring-webflow/wiki/Building-From-Source) from source are available via the project wiki.
  44
+
  45
+# Contributing
  46
+
  47
+[Pull requests](http://help.github.com/send-pull-requests) are welcome. You'll be asked to sign our contributor license agreement ([CLA](https://support.springsource.com/spring_committer_signup)). Trivial changes like typo fixes are especially appreciated (just [fork and edit](https://github.com/blog/844-forking-with-the-edit-button)!). For larger changes, please search through JIRA for similiar issues, creating a new one if necessary, and discuss your ideas with the Spring Web Flow team.
  48
+
  49
+# License
  50
+
  51
+Spring Web Flow is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
  52
+
  53
+
  54
+

0 notes on commit dae30d0

Please sign in to comment.
Something went wrong with that request. Please try again.