Skip to content

movingco/move-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Move Readme

Readme generator for Move packages.

Documentation is currently extremely sparse but will be improved in the near future.

Setup

Install the CLI using Cargo:

cargo install move-readme

# On Sui
cargo install move-readme --features address20

# On Aptos
cargo install move-readme --features address32

Usage

In a directory containing a Move.toml, run:

move-readme

This will write a README.md file to the current directory.

License

Move Readme is licensed under the Apache License, Version 2.0.

About

Readme generator for Move packages.

Resources

License

Stars

Watchers

Forks

Packages

No packages published