README.rdoc in fabricator-0.0.1 vs README.rdoc in fabricator-0.0.5
- old
+ new
@@ -1,33 +1,47 @@
= fabricator
-* FIX (url)
+Developed by
+Steffen Egelund Jensen
+Software designer
+Lenio A/S - www.lenio.dk
== DESCRIPTION:
-FIX (describe your package)
+This gem can generate a scaffold flex application based on PureMVC Multicore using the pipes utility abstracted by the fabrication framework.
+The initial application will be generated based on custom project name, title, src folder and package. Plus will include two modules:
+an authentication module and a dashboard module. It is intended that the gem in the future will be able to add new scaffold modules integrated with the application.
+New commands, proxies etc.
== FEATURES/PROBLEMS:
+
-* FIX (list of features or problems)
-
== SYNOPSIS:
+Generate PureMVC Multicore with pipes application abstracted by the Fabrication framework
+-Install and run
+ pureapp AppName org.my.custom.package 'app title'
+-Import flex project in Flex Builder
+-After compile run
+ AppNameShell.mxml
- FIX (code sample of usage)
+Generate module
+cd AppName
+ruby script/generate pure_module ModuleName
+i.e. ruby script/generate pure_module Address -> results in AddressModule.mxml plus generated code for the new module.
== REQUIREMENTS:
-* FIX (list of requirements)
+rubygems, ruby
== INSTALL:
-* FIX (sudo gem install, anything else)
+sudo gem install fabricator
== LICENSE:
(The MIT License)
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2009 Steffen Egelund Jensen
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
\ No newline at end of file