diff --git a/README.md b/README.md index cfe47c8..2751900 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pact-ts +# ts-pact TypeScript library for running and deploying Pact code. @@ -12,7 +12,7 @@ for instructions. ```typescript import pactLang from 'pact-lang-api' -import PactApi, { IKeyPair, pactUtils } from 'pact-ts' +import PactApi, { IKeyPair, pactUtils } from 'ts-pact' const keyPair = pactLang.crypto.genKeyPair() const args = [ @@ -30,12 +30,12 @@ return this.pactApi.eval({ ## Running scripts -This package comes with a few utility scripts in `src/scripts/.` +This package comes with some utility scripts in `src/scripts/`. The scripts will look in the environmental variables for a Pact key and URL to use when sending transactions, falling back to defaults if these are not available. See `src/scripts/config.ts` for details. -Compile the Node scripts: +Compile scripts: ``` yarn compile @@ -53,8 +53,7 @@ Deploy a contract or run a Pact script: node dist/src/scripts/runFile.js ``` -Example Node script for running a combination of files and commands in order to -deploy and initialize a set of smart contracts: +Example: deploy and initialize a set of smart contracts: ``` node dist/src/scripts/deployContracts.js diff --git a/package.json b/package.json index 018429d..e51ed61 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "name": "pact-ts", + "name": "ts-pact", "version": "0.1.1", - "author": "Blend", + "author": "Finprint", "license": "MIT", "description": "TypeScript library for running and deploying Pact code.", "repository": { "type": "git", - "url": "https://github.com/blend/pact-ts.git" + "url": "https://github.com/finprint/ts-pact.git" }, "main": "dist/src/index.js", "types": "dist/src/index.d.ts",