format readme better

This commit is contained in:
Edgar 2021-12-14 08:55:33 +01:00
parent f5f296b59e
commit 2203737431
No known key found for this signature in database
GPG key ID: 8731E6C0166EAA85
2 changed files with 94 additions and 94 deletions

View file

@ -17,54 +17,54 @@ It uses the [quick-xml](https://github.com/tafia/quick-xml) so it should be fast
use chrono::prelude::*; use chrono::prelude::*;
use sitewriter::{ChangeFreq, UrlEntry, UrlEntryBuilder}; use sitewriter::{ChangeFreq, UrlEntry, UrlEntryBuilder};
let urls = vec![ let urls = vec![
UrlEntryBuilder::default() UrlEntryBuilder::default()
.loc("https://edgarluque.com/projects".parse().unwrap()) .loc("https://edgarluque.com/projects".parse().unwrap())
.build() .build()
.unwrap(), .unwrap(),
UrlEntry { UrlEntry {
loc: "https://edgarluque.com/".parse().unwrap(), loc: "https://edgarluque.com/".parse().unwrap(),
changefreq: Some(ChangeFreq::Daily), changefreq: Some(ChangeFreq::Daily),
priority: Some(1.0), priority: Some(1.0),
lastmod: Some(Utc::now()), lastmod: Some(Utc::now()),
}, },
UrlEntry { UrlEntry {
loc: "https://edgarluque.com/blog".parse().unwrap(), loc: "https://edgarluque.com/blog".parse().unwrap(),
changefreq: Some(ChangeFreq::Weekly), changefreq: Some(ChangeFreq::Weekly),
priority: Some(0.8), priority: Some(0.8),
lastmod: Some(Utc::now()), lastmod: Some(Utc::now()),
}, },
UrlEntry { UrlEntry {
loc: "https://edgarluque.com/blog/sitewriter".parse().unwrap(), loc: "https://edgarluque.com/blog/sitewriter".parse().unwrap(),
changefreq: Some(ChangeFreq::Never), changefreq: Some(ChangeFreq::Never),
priority: Some(0.5), priority: Some(0.5),
lastmod: Some(Utc.ymd(2020, 11, 22).and_hms(15, 10, 15)), lastmod: Some(Utc.ymd(2020, 11, 22).and_hms(15, 10, 15)),
}, },
UrlEntry { UrlEntry {
loc: "https://edgarluque.com/blog/some-future-post" loc: "https://edgarluque.com/blog/some-future-post"
.parse() .parse()
.unwrap(), .unwrap(),
changefreq: Some(ChangeFreq::Never), changefreq: Some(ChangeFreq::Never),
priority: Some(0.5), priority: Some(0.5),
lastmod: Some( lastmod: Some(
Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()), Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()),
), ),
}, },
// Entity escaping // Entity escaping
UrlEntry { UrlEntry {
loc: "https://edgarluque.com/blog/test&id='<test>'" loc: "https://edgarluque.com/blog/test&id='<test>'"
.parse() .parse()
.unwrap(), .unwrap(),
changefreq: Some(ChangeFreq::Never), changefreq: Some(ChangeFreq::Never),
priority: Some(0.5), priority: Some(0.5),
lastmod: Some( lastmod: Some(
Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()), Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()),
), ),
}, },
]; ];
let result = sitewriter::generate_str(&urls); let result = sitewriter::generate_str(&urls);
println!("{}", result); println!("{}", result);
``` ```
### CREV - Rust code reviews - Raise awareness ### CREV - Rust code reviews - Raise awareness

View file

@ -15,54 +15,54 @@
//! use chrono::prelude::*; //! use chrono::prelude::*;
//! use sitewriter::{ChangeFreq, UrlEntry, UrlEntryBuilder}; //! use sitewriter::{ChangeFreq, UrlEntry, UrlEntryBuilder};
//! //!
//! let urls = vec![ //! let urls = vec![
//! UrlEntryBuilder::default() //! UrlEntryBuilder::default()
//! .loc("https://edgarluque.com/projects".parse().unwrap()) //! .loc("https://edgarluque.com/projects".parse().unwrap())
//! .build() //! .build()
//! .unwrap(), //! .unwrap(),
//! UrlEntry { //! UrlEntry {
//! loc: "https://edgarluque.com/".parse().unwrap(), //! loc: "https://edgarluque.com/".parse().unwrap(),
//! changefreq: Some(ChangeFreq::Daily), //! changefreq: Some(ChangeFreq::Daily),
//! priority: Some(1.0), //! priority: Some(1.0),
//! lastmod: Some(Utc::now()), //! lastmod: Some(Utc::now()),
//! }, //! },
//! UrlEntry { //! UrlEntry {
//! loc: "https://edgarluque.com/blog".parse().unwrap(), //! loc: "https://edgarluque.com/blog".parse().unwrap(),
//! changefreq: Some(ChangeFreq::Weekly), //! changefreq: Some(ChangeFreq::Weekly),
//! priority: Some(0.8), //! priority: Some(0.8),
//! lastmod: Some(Utc::now()), //! lastmod: Some(Utc::now()),
//! }, //! },
//! UrlEntry { //! UrlEntry {
//! loc: "https://edgarluque.com/blog/sitewriter".parse().unwrap(), //! loc: "https://edgarluque.com/blog/sitewriter".parse().unwrap(),
//! changefreq: Some(ChangeFreq::Never), //! changefreq: Some(ChangeFreq::Never),
//! priority: Some(0.5), //! priority: Some(0.5),
//! lastmod: Some(Utc.ymd(2020, 11, 22).and_hms(15, 10, 15)), //! lastmod: Some(Utc.ymd(2020, 11, 22).and_hms(15, 10, 15)),
//! }, //! },
//! UrlEntry { //! UrlEntry {
//! loc: "https://edgarluque.com/blog/some-future-post" //! loc: "https://edgarluque.com/blog/some-future-post"
//! .parse() //! .parse()
//! .unwrap(), //! .unwrap(),
//! changefreq: Some(ChangeFreq::Never), //! changefreq: Some(ChangeFreq::Never),
//! priority: Some(0.5), //! priority: Some(0.5),
//! lastmod: Some( //! lastmod: Some(
//! Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()), //! Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()),
//! ), //! ),
//! }, //! },
//! // Entity escaping //! // Entity escaping
//! UrlEntry { //! UrlEntry {
//! loc: "https://edgarluque.com/blog/test&id='<test>'" //! loc: "https://edgarluque.com/blog/test&id='<test>'"
//! .parse() //! .parse()
//! .unwrap(), //! .unwrap(),
//! changefreq: Some(ChangeFreq::Never), //! changefreq: Some(ChangeFreq::Never),
//! priority: Some(0.5), //! priority: Some(0.5),
//! lastmod: Some( //! lastmod: Some(
//! Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()), //! Utc.from_utc_datetime(&Local.ymd(2020, 12, 5).and_hms(12, 30, 0).naive_utc()),
//! ), //! ),
//! }, //! },
//! ]; //! ];
//! //!
//! let result = sitewriter::generate_str(&urls); //! let result = sitewriter::generate_str(&urls);
//! println!("{}", result); //! println!("{}", result);
//! ``` //! ```
//! //!
//! ## CREV - Rust code reviews - Raise awareness //! ## CREV - Rust code reviews - Raise awareness