Docs work #194
Docs work #194
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -0,0 +1,19 @@ | |||
| # Move Registry | |||
|
|
|||
| Move Registry is built to provide a name service for interacting / building with packages from the ecosystem. You could consider it the name service for packages. | |||
There was a problem hiding this comment.
| Move Registry is built to provide a name service for interacting / building with packages from the ecosystem. You could consider it the name service for packages. | |
| Move Registry provides a name service for interacting and building with packages from the ecosystem. |
|
|
||
| ## Why would I use the Move Registry? | ||
|
|
||
| Move Registry provides a uniform (single source of truth) naming service for packages in the Move ecosystem. |
There was a problem hiding this comment.
Probably this should be in introduction as well.
| ## Why would I use the Move Registry? | ||
|
|
||
| Move Registry provides a uniform (single source of truth) naming service for packages in the Move ecosystem. | ||
| This means that you can reference packages by their names, and the Move Registry will resolve the package address for you, despite the network*. |
There was a problem hiding this comment.
| This means that you can reference packages by their names, and the Move Registry will resolve the package address for you, despite the network*. | |
| It allows to reference packages by their names, and the Move Registry will resolve the package address, despite the network. |
| Additionally, Move Registry helps with working with versioning of packages. You can call a specific version of a package easily, without having to | ||
| resolve the addresses yourself, or worry about the package being updated (name without a specified version defaults to the latest). |
There was a problem hiding this comment.
| Additionally, Move Registry helps with working with versioning of packages. You can call a specific version of a package easily, without having to | |
| resolve the addresses yourself, or worry about the package being updated (name without a specified version defaults to the latest). | |
| Additionally, Move Registry helps with working with versioning of packages. Call a specific version of a package easily, without having to | |
| resolve the addresses or worry about the package being updated. For example, name without a specified version defaults to the latest. |
| @@ -0,0 +1,10 @@ | |||
| # Best Practises | |||
There was a problem hiding this comment.
I think this would really benefit from an example.
|
|
||
| # Typescript SDK plugin | ||
|
|
||
| The purpose of the MVR TypeScript SDK plugin is to offer developers a seamless experience when building PTBs with MVR names. |
There was a problem hiding this comment.
Sorry about my noob question but what is an SDK plugin?
There was a problem hiding this comment.
Check more info here:
https://sdk.mystenlabs.com/typescript/plugins
| The purpose of the MVR TypeScript SDK plugin is to offer developers a seamless experience when building PTBs with MVR names. | ||
| This plugin resolves MVR names to their respective addresses before constructing the PTB, caching the results during each runtime. | ||
|
|
||
| This also applies to type names, which have traditionally been harder to refer to, especially across package upgrades. |
There was a problem hiding this comment.
| This also applies to type names, which have traditionally been harder to refer to, especially across package upgrades. | |
| This also applies to type names, especially across package upgrades. |
Co-authored-by: stefan-mysten <[email protected]>
Co-authored-by: stefan-mysten <[email protected]>
| ```bash | ||
| TODO: add installation command | ||
| ``` |
There was a problem hiding this comment.
Download the correct binary file according to your OS and architecture from GitHub release page:
https://github.com/MystenLabs/mvr/releases/latest
After downloading the file, rename the binary to mvr and put it on your PATH. Below are examples on how to do it on three popular shells:
For Zsh
- Open the
zshrcfile
nano ~/.zshrc- Add this line at the end, replacing
/path/to/your/folderwith the actual folder path to the binary:
export PATH="/path/to/your/folder:$PATH"- Save the file and source it to apply changes:
source ~/.zshrcFor bash
- Open your
.bashrcfile (or.bash_profileon macOS):
nano ~/.bashrc- Add this line at the end, replacing
/path/to/your/folderwith the actual folder path to the binary:
export PATH="/path/to/your/folder:$PATH"- Save the file and source it to apply changes:
source ~/.bashrcFor fish
- Open your Fish configuration file:
nano ~/.config/fish/config.fish- Add this line, replacing
/path/to/your/folderwith your desired path:
set -Ux fish_user_paths /path/to/your/folder $fish_user_paths- Fish automatically loads this file, so you don’t need to manually source it.
Now you can call mvr --help.
No description provided.