Updating for Release 0.1

CHANGES.txt

@@ -0,0 +1,77 @@
+                      JesterJ Release Notes
+
+Introduction
+------------
+JesterJ is an open source document ingestion framework, with a primary focus on making the process of getting
+documents into a search engine as smooth as possible, both for small, quick use cases such as prototypes and 
+large high volume production use cases.
+
+See http://www.jesterj.org for more information, and https://github.com/nsoft/jesterj for roadmap/status
+
+
+Getting Started
+---------------
+Java 1.8 VM or later is supported. Older VM's should be used at your own risk.
+
+In this release, there is an example Plan that can be run by passing -Djj.example=run on the command line
+This requires solr cloud with Zookeeper at 9983 on localhost and a collection named jjtest that is configured 
+similarly to the dynamic schema example that comes with Solr.
+
+Documentation can be found at https://github.com/nsoft/jesterj/wiki/Documentation
+
+==================  0.1 ==================
+
+Detailed Change List
+----------------------
+
+For a full list of commits included in the this release you can go here: 
+
+https://github.com/nsoft/jesterj/commits/releases/0.1
+
+
+Highlights
+----------------------
+
+ * Embedded Cassandra server
+
+ * Cassandra config and data location configurable, defaults to ~/.jj/cassandra
+
+ * Initial support for fault tolerance via logging statuses to the embedded cassandra server (WIP)           
+
+ * Log4j appender to write to Cassandra where desired
+
+ * Initial API/process for user written steps. 
+
+ * 40% test coverage (jacoco)
+
+ * Simple filesystem scanner
+
+ * 7 document processors implemented
+
+ * Processor to send batched results to solr.
+
+ * Runnable example to execute a plan that scans a filesystem, and indexes the documents in solr.
+
+New Features
+----------------------
+
+Issue #3: Scan a directory for files. [Gus Heck (Needham Software)]
+
+Issue #5: Step for human readable file sizes. [Dimitry Goldenberg (Hexastax)]
+
+Issue #6: We need a send to solr step. [Gus Heck (Needham Software)]
+
+Bug Fixes
+----------------------
+
+Issue #1: Initial startup running from a Jar fails. [Gus Heck (Needham Software)]
+
+Optimizations
+----------------------
+
+(Initial release)
+
+Other Changes
+----------------------
+
+

README.md

@@ -7,26 +7,26 @@ See the [web site](http://www.jesterj.org) and the [documentation](https://githu
 
 # Status
 
-## Working:
+Current release version: 0.1.
+
+## Features:
+
+In this release we have the following features
+
  * Embedded Cassandra server
  * Cassandra config and data location configurable, defaults to ~/.jj/cassandra
- * Log4j can log to embedded cassandra server for regular logs and FTI status reports
- * Options to specify regular logs go to file also, or only to file (and locations of the file) -> log4j config
- * Actual web site, deploy as Github site.
- * Official API/process for user written steps. (just implement DocumentProcessor)
+ * Initial support for fault tolerance via logging statuses to the embedded cassandra server (WIP)
+ * Log4j appender to write to Cassandra where desired
+ * Initial API/process for user written steps. (see [documentation](https://github.com/nsoft/jesterj/wiki/Documentation))
  * 40% test coverage (jacoco)
  * Simple filesystem scanner
  * Copy Field processor
  * Date Reformat processor
+ * Human Readable File Size processor 
  * Tika processor to extract content
- * Solr sender.
- * [Execute a Plan](https://github.com/nsoft/jesterj/blob/master/code/ingest/README.md) that scans a filesystem, and indexes the documents in solr!
+ * Solr sender to send documents to solr in batches.
+ * Runnable example to [execute a plan](https://github.com/nsoft/jesterj/blob/master/code/ingest/README.md) that scans a filesystem, and indexes the documents in solr.
 
-## TODO for 0.1:
- * Add Field Processor
- * Field value Number Format Processor
- * Fix up filesizes and provide slightly better metadata for demo execution
-
 Release 0.1 is intended to be the smallest functional unit. Plans and steps will need to be assembled 
 in code etc and only run locally, only single node supported. Documents indexed will have fields for mod-time, 
 file name and file size.

RELEASING.txt

@@ -0,0 +1,18 @@
+Things To Do when Cutting a Release
+
+1. Make sure CHANGES.txt seems up to date. Ideally we should update this as we go, but read the top, make sure it's
+   current and accurate.
+
+2. Update the top level README. Make sure that the feature list is up to date, and the roeadmap to future versions
+   seems sane, and doesn't contain completed items. 
+
+3. Commit the final updates to the above file locally. 
+
+4. Tag the commit with a tag named releases/<version> where version is something like 0.1 or 0.3.2 or 1.0 etc. Please
+   be sure to ANNOTATE THE TAG with a message like "<version> release" so that it will be pushed to github.
+
+5. Ensure that no issues with milestone less than or equal to the release version are open. Either close or
+   move to a future release as appropriate. Ensure every un assigned issue that has a label also has a release
+   unlabled issues are not accepted for development and thus do not need a release. 
+
+6. Push the tagged commit and the tag to the main repo using the command: git push --follow-tags