Garmelon/el
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Tweak readme and lib docs

Browse source
This commit is contained in:
Joscha 2024-12-08 00:19:51 +01:00
parent 4a4225f72c
commit cb96987115
2 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,12 +1,12 @@
# el # el
`el` is a Rust library for writing, modifying, and safely rendering HTML `el` is a no-dependencies Rust library for writing, modifying, and safely
elements as simple data structures. It is inspired by [hiccup] and named after a rendering HTML elements as simple data structures. It is inspired by [hiccup]
small helper function I once wrote in JS. and named after a small helper function I once wrote in JS.
[hiccup]: https://github.com/weavejester/hiccup [hiccup]: https://github.com/weavejester/hiccup
## Usage example ## Show me a simple example
```rs ```rs
use el::{Attr, Render, html::*}; use el::{Attr, Render, html::*};
@ -30,6 +30,10 @@ let page: String = html((
.unwrap(); .unwrap();
``` ```
## What now?
See the top-level crate documentation for more info.
## But what about that small helper function? ## But what about that small helper function?
Here it is in full, for posteriority: Here it is in full, for posteriority:

4
src/lib.rs
View file

@ -67,6 +67,10 @@
//! ``` //! ```
//! //!
//! [axum]: https://crates.io/crates/axum //! [axum]: https://crates.io/crates/axum
//!
//! ## But what about that small helper function?
//!
//! See the readme for more details.
#[cfg(feature = "axum")] #[cfg(feature = "axum")]
mod axum; mod axum;