README.md in tmp-0.0.1.pre vs README.md in tmp-1.0.0
- old
+ new
@@ -1,4 +1,49 @@
tmp
===
-Ruby DSL for manage tmp files and make easy tmp commands / variables accross the forked processes. I'ts not made for shared memory management! it's main
+Ruby DSL for manage tmp files and make easy
+tmp commands / variables to file system
+Sometimes usefull for forked processes.
+
+I'ts not made for shared memory management!
+The main goal is to provide dsl for easy tmp files making on the filesystem
+
+
+### Example
+
+```ruby
+ require 'tmp'
+
+ TMP.write :test, {hello: 'world'}
+ puts TMP.read(:test)
+
+ # or you can use syntax sugar!
+ tmp.hello = { hello: 'world'}
+
+ # defined variable
+ puts tmp.hello #> { hello: 'world'}
+
+ # undefined variable
+ puts tmp.sup #> nil
+```
+
+### Config
+
+you can config the folder path for custom tmp folder use case if you dont want to use the systems default tmp folder/ your app space
+
+```ruby
+ require 'tmp'
+
+ TMP::Config.folder_path File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder'))
+
+ # or you can use syntax sugar!
+ tmp.hello = { hello: 'world'}
+ # defined variable
+ puts tmp.hello #> { hello: 'world'}
+```
+
+### TODO
+
+* make ssl encryption for the tmp files opt able
+* implement more awesome trick
+* find contributors