App defaults in readme

nachos · Sep 25, 2015 · 55acfd2 · 55acfd2
1 parent 900e027
commit 55acfd2
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,22 @@ var nachosConfig = require('nachos-config');
 
 See [settings-file](https://github.com/nachos/settings-file) documentation to see list of available functions
 
+## Extra functions
+Nachos config has extra functions on top of the SettingsFile functions
+
+### App defaults
+```js
+nachosConfig.getDefaultApp('txt')
+  .then(function (command) {
+    // command => /var/bin/gedit.desktop
+  });
+
+nachosConfig.setDefaultApp('txt', '/var/bin/gedit.desktop')
+  .then(function () {
+    // saved successfully!
+  });
+```
+
 ## Run Tests
 ``` bash
 $ npm test