From 5e493be1981af0aac12c397758bd7610f34e9cde Mon Sep 17 00:00:00 2001 From: Justin Tocci Date: Tue, 8 Nov 2016 17:00:58 -0600 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2ac7172..6cb4664 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ In order to accomplish all this magic, Letterbox makes several interesting choic Electron (by Github) is an application shell that provides you with several important components. The first is the web engine from Chromium, which renders your HTML and Javascript just like a browser. In order to display your HTML and Javascript files you need a webserver, so Electron provides and embeds a Node server. Finally, Electron helps you package your application so that you can easily distribute it to Linux, Mac and Windows computers. Electron is a powerful combination of technologies and effort. #### PostgreSQL -PostgreSQL is an enterprise class, open source object-relational database. Letterbox brings statically compiled binaries of PostgreSQL for Linux, Mac and Windows into Node modules. +PostgreSQL is an enterprise class, open source object-relational database. Letterbox helps you package Envelope applications with Electron that connect to PostgreSQL. + +[Postcard](https://github.com/workflowproducts/postcard), a related open source project, brings portable binaries of PostgreSQL for Linux, Mac and Windows into Node modules. #### Envelope Envelope helps you publish web apps based on your PostgreSQL database. It includes a powerful set of custom HTML tags called "Web Components" that can be configured to talk directly to your database. This saves your from writing code in middleware. By simplifying your web app's architecture, you can write your app with less context switch. This reduces cognitive load making it easier to think clearly about what your app is trying to do. @@ -25,17 +27,17 @@ There are two functions in Letterbox: `letterbox.init(appName, postgresHost, postgresPort, callback)` - **appName** - - Letterbox uses this to create a folder to hold the configuration file for envelope + - Letterbox uses this to create a folder to hold the configuration file for Envelope. - **postgresHost** - - Letterbox uses this to tell envelope how to connect to postgres + - Letterbox uses this to tell envelope how to connect to PostgreSQL. - **postgresPort** - - Letterbox uses this to tell envelope how to connect to postgres + - Letterbox uses this to tell envelope how to connect to PostgreSQL. - **callback(envelopePort)** - - This function will be called after envelope has started up, the `envelopePort` argument will allow you to tell Electron where to go + - This function will be called after envelope has started up, the `envelopePort` argument will allow you to tell Electron where to go to connect to Envelope. `letterbox.quit()` -- You need to call this function when the process is going to exit. If you don't then envelope will keep running and you won't be able to start it the next time. +- You need to call this function when the process is going to exit. If you don't then Envelope will keep running and you won't be able to start it the next time you launch the application. ## Example @@ -70,3 +72,4 @@ There are two functions in Letterbox: letterbox.quit(); }); +