From 16b8e48535fbfe86f5b3dff57c7fb99c35d2f7d0 Mon Sep 17 00:00:00 2001 From: josh rotenberg Date: Wed, 25 Oct 2023 16:35:59 -0700 Subject: [PATCH] add basic readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e056f9d --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# time-rs book + +[![Build](https://github.com/time-rs/book/actions/workflows/build.yaml/badge.svg)](https://github.com/time-rs/book/actions/workflows/build.yaml) + +## time documentation + +This repository contains the [mdbook](https://github.com/rust-lang/mdBook) source for the [time-rs](https://github.com/time-rs/time) crate [book](https://time-rs.github.io/book/). + +## Contributing + +Contributions are always welcome! If you have an idea, it's best to float it by me before working on +it to ensure no effort is wasted. If there's already an open issue for it, knock yourself out. +Internal documentation can be viewed [here](https://time-rs.github.io/internal-api/time). + +If you have any questions, feel free to use [Discussions]. Don't hesitate to ask questions — that's +what I'm here for! + +[Discussions]: https://github.com/time-rs/time/discussions + +## License + +This project is licensed under either of + +- [Apache License, Version 2.0](https://github.com/time-rs/time/blob/main/LICENSE-Apache) +- [MIT license](https://github.com/time-rs/time/blob/main/LICENSE-MIT) + +at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in +time by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any +additional terms or conditions.