OpenSource/axum
OpenSource/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2024-11-27 09:43:29 +01:00
Code Issues Projects Releases Packages Wiki Activity
axum/axum-debug/README.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
# axum-debug
axum-debug readme fixes (#499) * Fix build status badge in axum-debug * fix links * fix one more link
2021-11-11 17:53:07 +01:00
[![Build status](https://github.com/tokio-rs/axum/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/tokio-rs/axum-debug/actions/workflows/CI.yml)
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
[![Crates.io](https://img.shields.io/crates/v/axum-debug)](https://crates.io/crates/axum-debug)
[![Documentation](https://docs.rs/axum-debug/badge.svg)](https://docs.rs/axum-debug)
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
This is a debugging crate that provides better error messages for [`axum`]
framework.
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
More information about this crate can be found in the [crate documentation][docs].
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
## Safety
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% safe Rust.
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
## Minimum supported Rust version
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
axum-debug readme fixes (#499) * Fix build status badge in axum-debug * fix links * fix one more link
2021-11-11 17:53:07 +01:00
axum-debug's MSRV is 1.54.
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
## Getting Help
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
You're also welcome to ask in the [Discord channel][chat] or open an [issue]
with your question.
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
## Contributing
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
:balloon: Thanks for your help improving the project! We are so happy to have
you! We have a [contributing guide][contributing] to help you get involved in the
`axum` project.
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
## License
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
This project is licensed under the [MIT license][license].
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
### Contribution
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `axum` by you, shall be licensed as MIT, without any
additional terms or conditions.
Move `axum-debug` crate to workspace (#497) * add axum-debug to workspace * update readme * add changes to changelog * little docs update * fix the gap a tab has leaked into workspace Cargo.toml, it must be fixed * address clippy warnings
2021-11-11 15:18:40 +01:00
[`axum`]: https://crates.io/crates/axum
axum-debug readme fixes (#499) * Fix build status badge in axum-debug * fix links * fix one more link
2021-11-11 17:53:07 +01:00
[chat]: https://discord.gg/tokio
[contributing]: /CONTRIBUTING.md
Clean up axum-debug crate (#498) * Clean up axum-debug crate Mostly just brings the crate more in line with the rest of the crates in the workspace. I've also removed the axum-debug-macros crate since axum-debug only contained one re-export from axum-debug-macros. So we didn't need two crates. Can always bring the "backend" crate back if we need things in axum-debug that aren't proc-macros. * Just testing: This should make CI fail * Misc CI clean up * fix intentional breakage * fix changelog * Remove rustfmt config for now as it gives warnings on stable * Fix paths
2021-11-11 17:33:33 +01:00
[docs]: https://docs.rs/axum-debug
axum-debug readme fixes (#499) * Fix build status badge in axum-debug * fix links * fix one more link
2021-11-11 17:53:07 +01:00
[license]: /axum-debug/LICENSE
[issue]: https://github.com/tokio-rs/axum/issues/new
Reference in a new issue Copy permalink