Move README to src/main/asciidoc

src/main/asciidoc/README.adoc

@@ -0,0 +1,24 @@
+include::intro.adoc[]
+
+== TODO List
+
+- [x] Example front end app (currently in sandbox)
+- [x] Example back end service (currently in sandbox)
+- [x] Use platform config
+- [x] Hystrix integration (hystrix-javanica)
+- [x] Feign use spring message converters
+- [x] Ribbon (static server list)
+- [x] Eureka boot app (Service registration)
+- [x] Eureka (apache -> tomcat) see https://github.com/cfregly/fluxcapacitor/wiki/NetflixOSS-FAQ#eureka-service-discovery-load-balancer and https://groups.google.com/forum/?fromgroups#!topic/eureka_netflix/g3p2r7gHnN0
+- [x] Archaius bridge to spring environment
+- [x] Ribbon (Client side load balancing) (Eureka integration)
+  - [x] Remove need for *-eureka.properties
+  - [ ] Use spring boot values as defaults where appropriate
+  - [x] Synchronous removal of service from eureka on shutdown
+- [x] Refresh log levels dynamically
+- [x] Router (Zuul) integrated using hystrix/ribbon/eureka
+- [ ] Better observable example
+- [ ] Distributed refresh environment via platform bus
+- [x] Metrics aggregation (turbine)
+  - [x] Use Eureka for instance discovery rather than static list see https://github.com/Netflix/Turbine/blob/master/turbine-contrib/src/main/java/com/netflix/turbine/discovery/EurekaInstanceDiscovery.java
+  - [ ] Configure InstanceDiscovery.impl using auto config/config props

src/main/asciidoc/intro.adoc

@@ -0,0 +1,3 @@
+This project provides Netflix OSS integrations for Spring Boot apps through autoconfiguration
+and binding to the Spring Environment and other Spring programming model idioms.
+

src/main/asciidoc/spring-cloud-netflix.adoc

@@ -1,7 +1,6 @@
 = Spring Cloud Netflix
 
-This project provides Netflix OSS integrations for Spring Boot apps through autoconfiguration
-and binding to the Spring Environment and other Spring programming model idioms.
+include::intro.adoc[]
 
 == Service Discovery: Eureka Clients
 

src/main/ruby/generate_readme.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+base_dir = File.join(File.dirname(__FILE__),'../../..')
+src_dir = File.join(base_dir, "/src/main/asciidoc")
+require File.join(File.dirname(__FILE__), 'readme.rb')
+
+options = {}
+ARGV.length > 0 and options[:to_file] = ARGV[0]
+
+SpringCloud::Build.render_file("#{src_dir}/README.adoc", options)

src/main/ruby/readme.rb

@@ -0,0 +1,51 @@
+module SpringCloud
+  module Build
+
+    IncludeDirectiveRx = /^\\?include::([^\[]+)\[(.*?)\]$/
+
+    class << self
+
+      def process_include out, src, target, attrs
+        unless target.start_with?('/')
+          target = File.new(File.join(src, target))
+        else
+          target = File.new(target)
+        end
+        target.each do |line|
+          self.process(out, File.dirname(target), line)
+        end
+      end
+
+      def process out, src, line
+        if ((escaped = line.start_with?('\\include::')) || line.start_with?('include::')) && (match = IncludeDirectiveRx.match(line))
+          if escaped
+            out << line[1..-1]
+          else
+            self.process_include out, src, match[1], match[2].strip
+          end
+        else
+          out << line
+        end
+      end
+
+      def render_file file, options = {}
+
+        srcDir = File.dirname(file)
+        out = ["// Do not edit this file (go to #{file} instead)",""]
+        File.new(file).each do |line|
+          self.process(out, srcDir, line)
+        end
+
+        unless options[:to_file]
+          puts out
+        else
+          writer = File.new(options[:to_file],'w+')
+          out.each { |line| writer.write(line) }
+        end
+
+      end
+
+    end
+
+  end
+end