# Gitmodules

**Gitmodules is a simple parser for reading `.gitmodules` files.**

---

[Gitmodules][gitmodules] is a simple [Regex][regex] based parsing library for reading the [.gitmodules][git-submodule] file of a Git repository.


## Documentation

[Module documentation with examples](https://docs.rs/gitmodules).


## License

[Gitmodules][gitmodules] is licensed under either the

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)

or the

- MIT license ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT).


[gitmodules]: https://github.com/bwolf/gitmodules
[regex]: https://github.com/rust-lang/regex
[git-submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules