diff --git a/README.md b/README.md index c7b38ba..4fed61f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,28 @@ CLI utility written in TS, used to interact with laconicd. Depends on [registry-sdk](https://git.vdb.to/cerc-io/registry-sdk). +## Install + +- Add `.npmrc` file in desired project to resolve package + + ```bash + @cerc-io:registry=https://git.vdb.to/api/packages/cerc-io/npm/ + ``` + + This will set the registry for `cerc-io` scoped packages in the project + +- Install the CLI using package manager + + ```bash + yarn add @cerc-io/laconic-registry-cli + ``` + +- For installing CLI globally add `.npmrc` file above in home directory and run + + ```bash + yarn global add @cerc-io/laconic-registry-cli + ``` + ## Setup * Run `yarn` to install all dependencies. @@ -10,6 +32,12 @@ CLI utility written in TS, used to interact with laconicd. Depends on [registry- * Create a `config.yml` file from [config.example.yml](./config.example.yml) file. +* Add CLI cmd to path + + ```bash + export PATH="$PWD/bin:$PATH" + ``` + ## Account Setup Run the chain: diff --git a/test/README.md b/test/README.md index 877f65a..1a2e3fb 100644 --- a/test/README.md +++ b/test/README.md @@ -2,6 +2,12 @@ * Follow the project `Setup` and `Account Setup` from root [README](./../README.md) +* Add laconic cmd to path + + ```bash + export PATH="$PWD/bin:$PATH" + ``` + * Create a .env file using [.env.example](./.env.example): ```bash