diff --git a/README.md b/README.md index b1296b8..c60565a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Latest Version](https://img.shields.io/crates/v/avro-rs.svg)](https://crates.io/crates/avro-rs) [![Continuous Integration](https://github.com/flavray/avro-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/flavray/avro-rs/actions) [![Latest Documentation](https://docs.rs/avro-rs/badge.svg)](https://docs.rs/avro-rs) -[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/master/LICENSE) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/main/LICENSE) A library for working with [Apache Avro](https://avro.apache.org/) in Rust. @@ -563,13 +563,13 @@ assert_eq!(false, SchemaCompatibility::can_read(&writers_schema, &readers_schema ``` ## License -This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/master/LICENSE). +This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). Please note that this is not an official project maintained by [Apache Avro](https://avro.apache.org/). ## Contributing Everyone is encouraged to contribute! You can contribute by forking the GitHub repo and making a pull request or opening an issue. -All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/master/LICENSE). +All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). -Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/master/CHANGELOG.md). +Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md). If you introduce a backward-incompatible change, please consider adding instruction to migrate in the [Migration Guide](migration_guide.md) If you modify the crate documentation in `lib.rs`, run `make readme` to sync the README file. diff --git a/README.tpl b/README.tpl index 4b4d84d..daab35c 100644 --- a/README.tpl +++ b/README.tpl @@ -3,18 +3,18 @@ [![Latest Version](https://img.shields.io/crates/v/avro-rs.svg)](https://crates.io/crates/avro-rs) [![Continuous Integration](https://github.com/flavray/avro-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/flavray/avro-rs/actions) [![Latest Documentation](https://docs.rs/avro-rs/badge.svg)](https://docs.rs/avro-rs) -[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/master/LICENSE) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flavray/avro-rs/blob/main/LICENSE) {{readme}} ## License -This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/master/LICENSE). +This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). Please note that this is not an official project maintained by [Apache Avro](https://avro.apache.org/). ## Contributing Everyone is encouraged to contribute! You can contribute by forking the GitHub repo and making a pull request or opening an issue. -All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/master/LICENSE). +All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). -Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/master/CHANGELOG.md). +Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md). If you introduce a backward-incompatible change, please consider adding instruction to migrate in the [Migration Guide](migration_guide.md) If you modify the crate documentation in `lib.rs`, run `make readme` to sync the README file.