Update version and readme

PhiLhoSoft · May 31, 2016 · fcbba23 · fcbba23
1 parent 2a63140
commit fcbba23
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 140 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
-# RxNodeFS v. 0.2.0
+# RxNodeFS v. 0.2.1
+
+Library to wrap Node.js' FS library (filesystem) in RxJS' Observables.
+Currently only wrap directory reading (with optional recursion) and file reading.
 
 The [RxNodeFS](https://PhiLhoSoft.GitHub.io/) library exported as [Node.js](https://nodejs.org/) module.
 
@@ -13,3 +16,8 @@ $ npm i --save RxNodeFS
 ## TODO
 
 Describe how it works...
+
+Meanwhile, see the JSDoc of the library, it is quite detailed.
+
+Also see the test file TestRxNodeFS, and the example CheckLocalConsistency: this one is actually the primary reason this library exists, as I didn't want to cumulate callbacks on successive file reading...
+
diff --git a/examples/RxCustomObservable.js b/examples/RxCustomObservable.js
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "RxNodeFS",
 	"version": "0.2.1",
-	"description": "Library",
+	"description": "Library to wrap Node.js' FS library (filesystem) in RxJS' Observables",
 	"author": "PhiLho <PhiLho(a)GMX.net>",
 	"license": "Zlib",
 	"private": true,