README

snapcrunch · Jan 3, 2018 · 3e975bb · 3e975bb
1 parent 9a545d0
commit 3e975bb
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -170,6 +170,17 @@ ipcRenderer.on('preferencesUpdated', (e, preferences) => {
 ipcRenderer.sendSync('setPreferences', { ... });
 ```
 
+## Field Types
+
+The library includes built-in support for the following field types:
+
+- Text
+- Dropdown
+- Message
+- Folder selection
+
+Adding support for additional field types if easy, if you're familiar with React. PR's for such additions are welcome.
+
 ## Icons
 
 The following icons come packaged with the library and can be specified when you define the layout of your preferences window.

diff --git a/package.json b/package.json
@@ -1,8 +1,16 @@
 {
   "name": "electron-preferences",
-  "version": "0.0.2",
-  "description": "",
+  "version": "0.0.3",
+  "description": "A simple, consistent interface for managing user preferences within an Electron application.",
   "main": "index.js",
+  "repository" : {
+    "type" : "git",
+    "url" : "https://github.com/tkambler/electron-preferences.git"
+  },
+  "keywords": [
+    "electron",
+    "preferences"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "example": "cd example; electron main.js"