From 4e9b831039dae8ad617a75ef7a4594de6b61c854 Mon Sep 17 00:00:00 2001 From: Thorsten Muerell Date: Wed, 1 Nov 2017 08:44:53 +0100 Subject: [PATCH] Documentation --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 661b40f..603a5f2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # frog -This is a better TOAD. \ No newline at end of file +This is a better TOAD (i.e. a SQL client for Oracle Databases) + +## Usage + +* The best experience is with the `PL/SQL` extension installed. +* `Ctrl+Enter` executes the currently selected command +* The results are shown in a HTML preview window. You can use `Alt+Cmd+1` to switch the window to the bottom. + +## Configuration file + +To configure the available connections you can create a file named `.frog.json` in your home directory with a content like this: + +```json +{ "type": "folder", + "name": "root", + "items": [ + { "type": "folder", + "name": "Example Folder", + "items": [ + { + "type": "connection", + "name": "Connection 1", + "host": "127.0.0.1", + "port": 1521, + "sid": "world", + "username": "scott", + "password": "tiger" + } + ]} + ] +} +``` \ No newline at end of file