Skip to content

Commit

Permalink
add basic readme
Browse files Browse the repository at this point in the history
Update README.md

Co-authored-by: Jacob Pratt <[email protected]>

Update README.md

Co-authored-by: Jacob Pratt <[email protected]>

only show status for workflows on main

link to correct licenses

reword contributing and remove discussions and doc link
  • Loading branch information
joshrotenberg committed Oct 26, 2023
1 parent 9e83164 commit c51fe96
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# time-rs book

[![Build](https://github.com/time-rs/book/actions/workflows/build.yaml/badge.svg?branch=main)](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` crate](https://github.com/time-rs/time). The book can be viewed [here](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. If not,
open a new one.

## License

This project is licensed under either of

- [Apache License, Version 2.0](https://github.com/time-rs/book/blob/main/LICENSE-Apache)
- [MIT license](https://github.com/time-rs/book/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.

0 comments on commit c51fe96

Please sign in to comment.