From 79edc75f21786d8fabaee86e5298086e357c942e Mon Sep 17 00:00:00 2001 From: Kara Date: Thu, 28 Sep 2023 09:47:59 -0500 Subject: [PATCH] Update metadata & readme --- Cargo.toml | 11 ++++++----- README.md | 22 +++++++--------------- 2 files changed, 13 insertions(+), 20 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 05fb077df3..37160ff623 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,11 @@ [package] -name = "mdbook" -version = "0.4.34" +name = "mdbook-spacewizards" +version = "0.4.35" authors = [ "Mathieu David ", "Michael-F-Bryan ", - "Matt Ickstadt " + "Matt Ickstadt ", + "Space Wizards Federation" ] documentation = "https://rust-lang.github.io/mdBook/index.html" edition = "2021" @@ -12,7 +13,7 @@ exclude = ["/guide/*"] keywords = ["book", "gitbook", "rustbook", "markdown"] license = "MPL-2.0" readme = "README.md" -repository = "https://github.com/rust-lang/mdBook" +repository = "https://github.com/space-wizards/mdBook-spacewizards" description = "Creates a book from markdown files" rust-version = "1.66" @@ -66,7 +67,7 @@ search = ["dep:elasticlunr-rs", "dep:ammonia"] [[bin]] doc = false -name = "mdbook" +name = "mdbook-spacewizards" [[example]] name = "nop-preprocessor" diff --git a/README.md b/README.md index b2177cf307..cc36c41863 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,12 @@ -# mdBook +# mdBook-spacewizards -[![Build Status](https://github.com/rust-lang/mdBook/workflows/CI/badge.svg?event=push)](https://github.com/rust-lang/mdBook/actions?workflow=CI) -[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook) [![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE) -mdBook is a utility to create modern online books from Markdown files. +This is a fork of `mdBook` with several unmerged PRs integrated. This was originally forked to be used in https://github.com/space-wizards/docs, but of course anyone can use this fork. -Check out the **[User Guide]** for a list of features and installation and usage information. -The User Guide also serves as a demonstration to showcase what a book looks like. +The following PRs are integrated into the master branch: +- https://github.com/rust-lang/mdBook/pull/1306 +- https://github.com/rust-lang/mdBook/pull/1802 +- https://github.com/rust-lang/mdBook/pull/1618 -If you are interested in contributing to the development of mdBook, check out the [Contribution Guide]. - -## License - -All the code in this repository is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE] file. - -[User Guide]: https://rust-lang.github.io/mdBook/ -[contribution guide]: https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md -[LICENSE]: https://github.com/rust-lang/mdBook/blob/master/LICENSE +## Using in actions \ No newline at end of file