Welcome to HIP Validator 👋

Utility tool to validate the format of an HIP

🏠 Homepage

📦 Install

sh 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 number
• title: The HIP title is a few words, not a complete sentence
• description: Description is one full (short) sentence
• author: 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 status
• created: Date created on, in ISO 8601 (yyyy-mm-dd) format

Optional fields

• requires: HIP number(s)
• replaces: HIP number(s)

Commands

sh 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