Skip to content

Commit

Permalink
Update metadata & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mirrorcult committed Sep 28, 2023
1 parent 0583119 commit 79edc75
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 20 deletions.
11 changes: 6 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
[package]
name = "mdbook"
version = "0.4.34"
name = "mdbook-spacewizards"
version = "0.4.35"
authors = [
"Mathieu David <mathieudavid@mathieudavid.org>",
"Michael-F-Bryan <michaelfbryan@gmail.com>",
"Matt Ickstadt <mattico8@gmail.com>"
"Matt Ickstadt <mattico8@gmail.com>",
"Space Wizards Federation"
]
documentation = "https://rust-lang.github.io/mdBook/index.html"
edition = "2021"
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"

Expand Down Expand Up @@ -66,7 +67,7 @@ search = ["dep:elasticlunr-rs", "dep:ammonia"]

[[bin]]
doc = false
name = "mdbook"
name = "mdbook-spacewizards"

[[example]]
name = "nop-preprocessor"
Expand Down
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 79edc75

Please sign in to comment.