From 3e975bb767aaf555dd4c3e6b0888a2787ea9a5e9 Mon Sep 17 00:00:00 2001 From: Tim Ambler Date: Wed, 3 Jan 2018 15:50:53 -0600 Subject: [PATCH] README --- README.md | 11 +++++++++++ package.json | 12 ++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a07f67a..6fcec52 100644 --- 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 index 5e8a44e..a7fbdb8 100644 --- 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"