💬 All feedback is welcomed! Set up an issue.
ICNS is an open internet service built on the Internet Computer blockchain. The core protocol maps human-readable names to machine-readable crypto addresses and other customized user metadata, helping to remove the burden of memorizing crypto addresses. Your ICNS name will be your passport to the Web3 ecosystem.
ICNS-js provides interfaces for easily wiring up to and creating interactions with the four main ICNS canisters:
- The Registrar Canister
- The Registry Canister
- The Resolver Canister
- The Reverse Registrar Canister
Looking to get ICNS-js setup in your project? The ICNS docs are your best bet!
Get started with our documentation ➡️ here.
ICNS-js can be installed locally from our Github repository. To do so you're going to need a personal access token with the following configurations:
- repo
- read:packages
Next, authenticate yourself via npm login command using your Github email for the username and the personal access token as your password:
npm login --registry=https://npm.pkg.github.com --scope=@psychedelicThe last thing we’ve got to do before installing is set your npm configuration so that when you run npm install @psychedelic/, npm will pull from Github instead of its own registry.
To do this, we have two options:
- Run the following command
npm config set @psychedelic:registry https://npm.pkg.github.com- Add a
.npmrcfile to your project's root directory and add the following line to the file:
@psychedelic:registry=https://npm.pkg.github.comYou're all set! Install icns-js into your project with the following command:
yarn add @psychedelic/icns-jsICNS-js is modified from Sonic-js.