Improved documentation

ffissore · Jul 25, 2019 · 5ddb5d7 · 5ddb5d7
1 parent da5b162
commit 5ddb5d7
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -6,16 +6,16 @@
 
 # What's JRecordBind?
 
-A tiny and super fast library that aims to
+A tiny and super fast library that aims to:
 
 - parse fixed or variable length text files and map them to java beans (`Unmarshaller`)
-- export java beans to fixed or variable length text files (`Marshaller`).
+- export java beans to fixed or variable length text files (`Marshaller`)
 
 ## Why?
 
 Almost everybody has written an import procedure of some sort.
 
-Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file
+Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file.
 
 JRecordBind aims to leverage the boring parsing task and let the developer focus on the real problem: understanding the data and find a way to feed the persistence layer.
 

diff --git a/README.template.md b/README.template.md
@@ -6,16 +6,16 @@
 
 # What's JRecordBind?
 
-A tiny and super fast library that aims to
+A tiny and super fast library that aims to:
 
 - parse fixed or variable length text files and map them to java beans (`Unmarshaller`)
-- export java beans to fixed or variable length text files (`Marshaller`).
+- export java beans to fixed or variable length text files (`Marshaller`)
 
 ## Why?
 
 Almost everybody has written an import procedure of some sort.
 
-Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file
+Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file.
 
 JRecordBind aims to leverage the boring parsing task and let the developer focus on the real problem: understanding the data and find a way to feed the persistence layer.
 

diff --git a/generate_readme.sh b/generate_readme.sh
@@ -2,7 +2,9 @@
 
 set -e
 
-VERSION=$(grep version pom.xml | head -n 1 | grep -Po '\>.*\<' | sed 's/[<>]//g')
+if [ -z "$VERSION" ]; then
+  VERSION=$(grep version pom.xml | head -n 1 | grep -Po '\>.*\<' | sed 's/[<>]//g')
+fi
 
 sed "s/@@VERSION@@/$VERSION/g" README.template.md >README.md
 

diff --git a/jrecordbind/src/site/markdown/index.md b/jrecordbind/src/site/markdown/index.md
@@ -6,16 +6,16 @@
 
 # What's JRecordBind?
 
-A tiny and super fast library that aims to
+A tiny and super fast library that aims to:
 
 - parse fixed or variable length text files and map them to java beans (`Unmarshaller`)
-- export java beans to fixed or variable length text files (`Marshaller`).
+- export java beans to fixed or variable length text files (`Marshaller`)
 
 ## Why?
 
 Almost everybody has written an import procedure of some sort.
 
-Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file
+Fixed-length are a must for every public institution (at least in Italy): regardless of the age of the destination system, everyone can read a plain text file.
 
 JRecordBind aims to leverage the boring parsing task and let the developer focus on the real problem: understanding the data and find a way to feed the persistence layer.