1 stable release
1.0.0 | Nov 13, 2021 |
---|
#2 in #holium
15KB
112 lines
Welcome to HIP Validator 👋
Utility tool to validate the format of an HIP
🏠 Homepage
📦 Install
cargo install hip-validator
📝 Usage
Be sure to check the official documentation to know better how to use the Holium Rust SDK, with practical examples.
Validation rules
Mandatory fields
hip
: HIP numbertitle
: The HIP title is a few words, not a complete sentencedescription
: Description is one full (short) sentenceauthor
: A list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName foo@bar.com, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>status
: HIP statuscreated
: Date created on, in ISO 8601 (yyyy-mm-dd) format
Optional fields
requires
: HIP number(s)replaces
: HIP number(s)
Commands
hip-validator --help
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the dedicated section in the documentation.
🙋 Show your support
Give a ⭐️ if this project helped you and use the official badge to link to the project!
📝 License
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator
Dependencies
~8.5MB
~165K SLoC