From aed56d0e0de379a134c27be681c6c0d28d724e19 Mon Sep 17 00:00:00 2001 From: Gabriele Columbro Date: Wed, 14 Dec 2016 10:04:23 -0800 Subject: [PATCH] Updated Readme w/Project Goals per JC's guidance Added reference to project goals and Foundation Desktop Wrapper working group. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81089aa8..e797b787 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # SymphonyElectron -Instructions: +Project Goals: + +Our goal is to improve the performance and development agility of Symphony's desktop wrapper and build a path to support other wrappers by: + +1. Standardizing the JS to native interfaces +2. Standardizing the app to app interfaces (current embedding API) +3. Provide an open and free reference implementation that anyone can contribute to, modify, and make derivative works. + +In order to achieve those goals Symphony is participating and working in close collaboration with the [Foundation Desktop Wrapper Working Group](https://symphonyoss.atlassian.net/wiki/display/WGDWAPI/Working+Group+-+Desktop+Wrapper+API) + + + +Build Instructions: + - to pick up dependencies: npm install - to locally run mac version: npm run dev:mac - to locally run windows (64 bit) version: npm run dev:win