Skip to content

Commit

Permalink
Update npm package installation instructions. (#12)
Browse files Browse the repository at this point in the history
* Update npm package installation instructions.

This updates the npm package installation instructions for the readme.

* Bump patch version
  • Loading branch information
nohe427 authored Jan 4, 2022
1 parent 880eb4a commit 8ed9708
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

`android-package-sign-js` allows developers to generate signing keys and sign their Android packages (APK and AAB) in a browser.

# Use android-package-signer in a project

```
npm i @chromeos/android-package-signer
```

# To build the package

```
Expand Down Expand Up @@ -69,7 +75,7 @@ async signPackage(
Generate a signing key for your Android app:

```typescript
import { PackageSigner } from 'android-package-sign-js/index';
import { PackageSigner } from '@chromeos/android-package-signer';
async function keyGen(): Promise<string> {
const packageSigner = new PackageSigner(password, alias);
const base64Der = await packageSigner.generateKey({
Expand All @@ -95,7 +101,7 @@ async function keyGen(): Promise<string> {
To sign Android App Bundles and APKs with v1 signing can be called like this:

```typescript
import { PackageSigner } from 'android-package-sign-js/index';
import { PackageSigner } from '@chromeos/android-package-signer';

function loadStoredKeystore(): string {
// returns a base64 encoded keystore that was previously loaded
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@chromeos/android-package-signer",
"author": "Alexander Paul Nohe",
"license": "Apache-2.0",
"version": "0.1.0",
"version": "0.1.1",
"description": "Implementation of android package signing with zipalign that runs in a browser",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 8ed9708

Please sign in to comment.