From c0d043ada0522f7320744820abd3efcf22d113c7 Mon Sep 17 00:00:00 2001 From: Jonathan Cobb Date: Fri, 11 Dec 2020 06:46:43 -0500 Subject: [PATCH] update docs, readme --- LICENSE.md | 4 ++-- README.md | 11 ++++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 0b3ce5a..0dea3ed 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ # Copyright (C) 2020 Bubble, Inc. ## For ANY commercial use of this software -All rights are reserved. Please contact licensing@bubblev.com for more information. +All rights are reserved. Please contact licensing@getbubblenow.com for more information. ## For individuals and not-for-profit organizations If you are an individual person or a not-for-profit organization, and your usage of this software is entirely @@ -10,7 +10,7 @@ summarized below and reprinted in full thereafter. ```text Bubble - a privacy-first VPN - Copyright (C) 2019 Bubble, Inc. + Copyright (C) 2020 Bubble, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by diff --git a/README.md b/README.md index 33160fd..faa2d0d 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,24 @@ npm install ``` # Build the Webapp -Bubble uses [webpack](https://webpack.js.org/) to build the Bubble VueJS webapp. +Bubble uses [npm](https://www.npmjs.com/) and [webpack](https://webpack.js.org/) +to build the Bubble VueJS webapp. In the `bubble-web` directory, run this to build the webapp: ```shell script -webpack +npm run build ``` The output files will be in the `bubble-web/dist` directory. -To perform a production build, run: +To perform a development build (for example, so the VueJS firefox/chrome plugin will work), run: ```shell script -webpack --mode=production +npm run dev-build ``` # Run Webapp with a Remote Bubble API Server To connect to a remote Bubble API, set the `BUBBLE_API` environment variable and run: ```shell script -BUBBLE_API=https://bubble-api.example.com/api npm start +BUBBLE_API=https://bubble-api.example.com/api npm run start ``` This will run a local web server where you can use the webapp. The local web server will proxy API calls to the remote Bubble API server.