# Welcome to HIP Validator 👋

[![crates.io](https://img.shields.io/crates/v/hip_validator.svg)](https://crates.io/crates/hip_validator)
[![dependency status](https://deps.rs/repo/github/polyphene/hip-validator/status.svg)](https://deps.rs/repo/github/polyphene/hip-validator)

[![GitHub latest commit](https://badgen.net/github/last-commit/polyphene/hip-validator/main)](https://github.com/polyphene/hip-validator/commit/)
[![GitHub issues](https://img.shields.io/github/issues/polyphene/hip-validator.svg)](https://github.com/polyphene/hip-validator/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/polyphene/hip-validator.svg)](https://github.com/polyphene/hip-validator/pull/)

[![maintainer](https://img.shields.io/badge/maintainer-Polyphene-blue)](https://twitter.com/polyphenehq/)
[![Discord](https://img.shields.io/discord/882061839347908678.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/A3t5ZFSbCG)
[![license](https://badgen.net/github/license/polyphene/hip-validator)](https://raw.githubusercontent.com/polyphene/hip-validator/main/LICENSE)

> Utility tool to validate the format of an HIP

### 🏠 [Homepage](https://holium.org)

### 📦 Install

```sh
cargo install hip-validator
```
### 📝 [Usage](https://docs.holium.org)

Be sure to check the [official documentation](https://docs.holium.org) 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!

[![Made with Holium](https://img.shields.io/badge/Made%20with-HOLIUM-AD6CD6?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABoAAAAaCAYAAACpSkzOAAAErklEQVR42q2VA7DsWhaGuzC2Z0rjmdKwMLbLGj+rXM+2fW0dPF7b1rFtq3WSDjt7Z+/vdZKqa9f9q/928i1lJXU1Kitr/uzxtrbPRe9Xn8h+KnU9tXB79vedw9ajYzP24aFJixOdDhWHPVl2yIveT+Vm7Rcty/riNQNe2Wj8dled2ZPO2fi+jxCiZEnnuGR7o2RfmyRtCIIgwPeKw9aof9f09PQ3rgry7hHj1vYhW7uuR7EoKMyECF+hlCKQipytKLiKMIwcIoMQu0uQb3fI5XKvXhFkcDz7v5mcUwIUkVJiTCjyIxqlNFprhKdJd2umOjXubPKdUopQKLxxiZW3ycxk37skxDCMb6RHPGu0UWDno0gVmV6NOakhemjI9kPje3B8MTS+TxyEVqeAcXAFw2O8Kr/qoqDcjDV8bImgeo2iMJ1EPNkGs2MJJAxg6AQcmQe7ny75GTgyH6Y6QJ0B6xoL2VgWsH+O8+fzIIVC4emu/aUfX1V07UlKZE7AZCslKLECB/oOwqE3YtApH3odptqJMwtDTW2/Ys7ykPKnxNHzSmYbvteyMaRjh2Z2VKMV2BliWCgBkoxG66BqRZTN2bBjC8EcBxlqqvo0S7aErJ0nGF5p//4UyLbtRY4hmO5UODmNCjUAKiQCniU7DT374ei8s2F7noXWTWDnNF0Tmi31ioZqSe6kN+8UyPf9diEkKlRxnS8pBYUp6D0AJ5fBvpcSyL4Xoa4cJlsgZ2p6JhWuL5kZtjtPgzw/nhYVKGQ+LtulpcEzkv517YbmtZGTTNM9IAKNDJMJzEwUKLun+bMJyPXT0Zehq/C6NWIa0FxWWoFvgzVd8hR4sxAKTk2fEAKzYLNx7sjXUpmOzCdt0yEGFRVmi8ZuA5lNTnT1OgWK15NZUirS8PD0NyzTiul2VjF+VJM9CU4dFPtIgMWrg0SWUsbbJZ/Pl8Wg1ytbP5HN5Y2Inh1UNFZqRnZAdheY26GwB5waEBNXVM6zNoTneZy1aNPp9NPRhrayYWm1aJpXw/hmSK+AzFLIlYG1H2Tu6kClcx5OnSvXdRuj8nXvVRydq+lfD2Ml0NRrMDMHZtdBsR/Ql4YImUxcdK5SRofOA5nj1stRVm5BUlupOVYJXVtgYBmkl8DsBvC7LwzSGiwvunY01X2KzrEQwxaYlvP6eaCRddYvCuMuca9GFAc2ahqPaQaOQnYrFPaB3wcoTkkpmDKgql+zrkazZJ9i3i7F0v2SjdUB1d3+hW+EmQbz0SgrKSRDA4raek3/iMYaALcFioOgBbE0MJLV7GzWLNqreW6j4qn1Ja8LeXKt4Jn1/jOpS8lxnB+WxjKdtyWNg4qucYVb1MiMJhjTKC8Z31Bp+qc12xsVc3YmgAQieeL9YE3qSuRm3Z+aprCbBiW1fSEZU8V7MPQUKkimKnIgFBP5kB2Nkpc2S558P+DxtcX5qavRRK/zo6rO4vDmWsGRTkHOkkh5ynEvS5kTlXp42mNTlTv54mb3H6lr1bpj1i0r9hrDa49bVHdZtA5aNPXbset7S+/7jM7WIfP2fvhw6nrokdWj33po9eT3Hy+b+fkD5Zl/Pbg6fdODZZnvpq5QHwDCaw/yZpQynwAAAABJRU5ErkJggg==)](https://github.com/polyphene/holium-rs)

### 📝 License

This project is [MIT](https://raw.githubusercontent.com/polyphene/hip-validator/main/LICENSE) licensed.


***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_