-
Notifications
You must be signed in to change notification settings - Fork 165
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Renames llama-pack => BubbleWrap #121
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,25 +14,21 @@ | |
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
# 🦙Llama Pack CLI | ||
![Node CI Status](https://github.com/GoogleChromeLabs/llama-pack/workflows/Node%20CI/badge.svg) | ||
# Bubblewrap CLI | ||
![Node CI Status](https://github.com/GoogleChromeLabs/bubblewrap/workflows/Node%20CI/badge.svg) | ||
|
||
Llama Pack is a Command Line Interface (CLI) that helps developers to create | ||
Bubblewrap is a Command Line Interface (CLI) that helps developers to create | ||
a Project for an Android application that launches an existing Progressive Web App (PWA) using a | ||
[Trusted Web Activity (TWA)](https://developers.google.com/web/updates/2019/02/using-twa). | ||
|
||
**Important:** llama-pack is still under active development. The tool hasn't been tested on a wide | ||
range of Web APKs, and bootstraping a new project may fail in those cases. Please, file issues, | ||
feature requests, and contribute with pull requests, if possible. | ||
|
||
## Requirements | ||
- [Node.js](https://nodejs.org/en/) 10.0 or above | ||
|
||
## Setting up the Environment | ||
|
||
### Get the Java Development Kit (JDK) 8. | ||
The Android Command line tools requires the correct version of the JDK to run. To prevent version | ||
conflicts with a JDK version that is already installed, llama-pack uses a JDK that can unzipped in | ||
conflicts with a JDK version that is already installed, Bubblewrap uses a JDK that can unzipped in | ||
a separate folder. | ||
|
||
Download a version of JDK 8 that is compatible with your OS from | ||
|
@@ -47,35 +43,35 @@ Download a version of Android command line tools that is compatible with your OS | |
[https://developer.android.com/studio#command-tools](https://developer.android.com/studio#command-tools). | ||
Create a folder and extract the downloaded file into it. | ||
|
||
### Tell llama-pack where the JDK and Android command line tools are | ||
When running `llama-pack` for the first time, it will ask where it can find the JDK and Android command | ||
### Tell Bubblewrap where the JDK and Android command line tools are | ||
When running `bubblewrap` for the first time, it will ask where it can find the JDK and Android command | ||
line tools. So, take note of the location where both were decompressed. | ||
|
||
|
||
## Using llama-pack | ||
## Using Bubblewrap | ||
|
||
### Installing llama-pack | ||
### Installing Bubblewrap | ||
|
||
```shell | ||
npm i -g @llama-pack/cli | ||
npm i -g @bubblewrap/cli | ||
``` | ||
|
||
### Initializing an Android Project | ||
Generate an Android project from an existing Web Manifest: | ||
|
||
```shell | ||
llama-pack init --manifest https://my-twa.com/manifest.json | ||
bubblewrap init --manifest https://my-twa.com/manifest.json | ||
``` | ||
|
||
When initalizing a project, llama-pack will download the Web Manifest and ask you to confirm | ||
When initalizing a project, Bubblewrap will download the Web Manifest and ask you to confirm | ||
the values that should be used when building the Android project. | ||
|
||
It will also ask you for the details needed to generate a signing key, used to sign the | ||
app before uploading to the Play Store. | ||
|
||
### Building the Android Project | ||
```shell | ||
llama-pack build | ||
bubblewrap build | ||
``` | ||
|
||
When building the project for the first time, the Android Build Tools will need to be installed. | ||
|
@@ -96,6 +92,6 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. | |
|
||
See [LICENSE](../../LICENSE) for more. | ||
|
||
## Disclaimer | ||
## Disclaimer | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove trailing space |
||
|
||
This is not a Google product. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,25 +14,21 @@ | |
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
# 🦙Llama Pack Core | ||
![Node CI Status](https://github.com/GoogleChromeLabs/llama-pack/workflows/Node%20CI/badge.svg) | ||
# Bubblewrap Core | ||
![Node CI Status](https://github.com/GoogleChromeLabs/bubblewrap/workflows/Node%20CI/badge.svg) | ||
|
||
Llama Pack Core is a NodeJS library that helps developers to create a Project for an Android | ||
Bubblewrap Core is a NodeJS library that helps developers to create a Project for an Android | ||
application that launches an existing Progressive Web App (PWA) using a | ||
[Trusted Web Activity (TWA)](https://developers.google.com/web/updates/2019/02/using-twa). | ||
|
||
**Important:** llama-pack is still under active development. The tool hasn't been tested on a wide | ||
range of Web APKs, and bootstraping a new project may fail in those cases. Please, file issues, | ||
feature requests, and contribute with pull requests, if possible. | ||
|
||
## Requirements | ||
- [Node.js](https://nodejs.org/en/) 10.0 or above | ||
|
||
## Setting up the Environment | ||
|
||
### Get the Java Development Kit (JDK) 8. | ||
The Android Command line tools requires the correct version of the JDK to run. To prevent version | ||
conflicts with a JDK version that is already installed, llama-pack uses a JDK that can unzipped in | ||
conflicts with a JDK version that is already installed, Bubblewrap uses a JDK that can unzipped in | ||
a separate folder. | ||
|
||
Download a version of JDK 8 that is compatible with your OS from | ||
|
@@ -47,10 +43,10 @@ Download a version of Android command line tools that is compatible with your OS | |
[https://developer.android.com/studio#command-tools](https://developer.android.com/studio#command-tools). | ||
Create a folder and extract the downloaded file into it. | ||
|
||
## Using llama-pack-core in a NodeJs project | ||
## Using @bubblewrap/core in a NodeJs project | ||
|
||
```shell | ||
npm i -g @llama-pack/core | ||
npm i -g @bubblewrap/core | ||
``` | ||
|
||
## Contributing | ||
|
@@ -61,6 +57,7 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. | |
|
||
See [LICENSE](../../LICENSE) for more. | ||
|
||
## Disclaimer | ||
## Disclaimer | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. trailing space |
||
|
||
This is not a Google product. | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove trailing space