move-readme

Crates.iomove-readme
lib.rsmove-readme
version0.1.0
sourcesrc
created_at2022-07-09 03:51:19.877574
updated_at2022-07-09 03:51:19.877574
descriptionGenerates a readme from a Move package.
homepagehttps://moving.wtf
repositoryhttps://github.com/movingco/move-readme
max_upload_size
id622259
size49,422
Ian Macalinao (macalinao)

documentation

README

move-readme

Generates a readme from a Move package.

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: Apache-2.0

Commit count: 7

cargo fmt