Skip to content

Commit

Permalink
changed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
erhard committed May 25, 2014
1 parent b7be926 commit 12fc84d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ test
prod
*.png
site/dev/images/galleries
*.gem
4 changes: 2 additions & 2 deletions mixItRuby.gemspec
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Gem::Specification.new do |s|
s.name = 'mixItRuby'
s.version = '0.0.0'
s.date = '2014-05-29'
s.summary = "MitItRuby!"
s.date = '2014-05-25'
s.summary = "MixItRuby! mixes json in erb + CLI"
s.description = "A gem for mixing a nested json structure in erb files"
s.authors = ["Erhard Karger"]
s.email = '[email protected]'
Expand Down
17 changes: 7 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
MIX
mixItRuby
===

What is MIX ?
What is mixItRuby ?
-------------
Mix is a gem for mixing data with tamplatefiles.
Mix is a gem for mixing data with templatefiles.

Example Use Case
----------------
Expand All @@ -13,17 +13,14 @@ What you do :
Run mix with a erb template. Viola the output is (depending on the template)
ready to be formatted in latex of whatever.

But whatever......



Install
-------
gem mix
gem install mixItRuby

run (form commandline)
-----------------------
mix inputfile template outputfile
mixit -i inputfile < -t templateDir -o outputfile >


run withing a programm
Expand Down Expand Up @@ -62,9 +59,9 @@ recursive : substructures possible (nodes)

A building block consists of an id and other key value pair.

id: is a must. It represents the Identifier under which the template is accesible.
id: is a must. It represents the identifier under which the template is accesible.
At the moment it is a filename. The other attributes on the same level, which are no array or hash are
the key value pais which fill the erb.
the key value pairs which fill the erb.
The adress.erb looks like this
<%=name%>, <%=prename%>
Then an array follow. An Array must be build of hashes, which can have subarrays or like in the example building blocks again.
Expand Down

0 comments on commit 12fc84d

Please sign in to comment.