Skip to content
Browse files

removed migration message, added quick example

  • Loading branch information...
1 parent 8ca39aa commit 28a9a2b3eecf722c3574384a026d50002a0f154d Gabriel Llamas committed Dec 11, 2013
Showing with 19 additions and 7 deletions.
  1. +19 −7 README.md
View
26 README.md
@@ -12,6 +12,25 @@ properties
This module implements the Java .properties specification and adds additional features like [ini](#ini) sections, variables (key referencing), namespaces, importing files and much more.
+#### Quick example ####
+
+```
+# file
+a = 1
+b: 2
+```
+
+```javascript
+var properties = require ("properties");
+
+properties.load ("file", { path: true }, function (error, obj){
+ if (error) return console.error (error);
+
+ console.log (obj);
+ //{ a: 1, b: 2 }
+});
+```
+
#### Documentation ####
- [Sections](#sections)
@@ -32,13 +51,6 @@ This module implements the Java .properties specification and adds additional fe
- [Stringifier](#Stringifier)
-#### Migration from v0.3 to v1
-
-- `load()` and `store()` have been removed. Now `parse()` and `stringify()` can read and write from/to files using the `path` option.
-- `stringify()` has been refactored. Now a `Stringifier` can be used to stringify an object if you want to write sections or comments.
-- The `pretty` option has been removed from `stringify()`.
-- The `replacer` from `stringify()` must be a function. Cannot be an array like in previous versions.
-
---
<a name="sections"></a>

0 comments on commit 28a9a2b

Please sign in to comment.
Something went wrong with that request. Please try again.