From 3e3879e48ec3a39219702a8583fa8fec519f1aef Mon Sep 17 00:00:00 2001 From: Ewen Date: Sun, 12 May 2024 11:28:55 +0200 Subject: [PATCH] fix: readme format --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d5e2858..4ae51ce 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,20 @@ This project consists of two parts : ### Parameters -- `**url**` (required): the URL of the page -- `**article**` (required): the HTML tag encapsulating a feed item -- `**title**` (required): the HTML tag of the article title -- `**articleClass**`: a class name helping to filter the article element -- `**titleClass**`: a class name helping to filter the title element -- `**section**`: the HTML tag encapsulating the group of items. If not given, the entire page will be used -- `**content**`: the HTML tag encapsulating the content, or description, of the item. The default is `p` -- `**contentClass**`: a class name helping to filter the content element -- `**link**`: the HTML tag encapsulating the link to the item. The default is `a`. -- `**linkClass**`: a class name helping to filter the link element -- `**datetime**`: the HTML tag encapsulating the date and time of the item. Any date and time format can be used, the parser will try to understand the format. -- `**datetimeClass**`: a class name helping to filter the datetime element -- `**author**`: the HTML tag encapsulating the author of the item -- `**authorClass**`: a class name helping to filter the author element +- `url` (required): the URL of the page +- `article` (required): the HTML tag encapsulating a feed item +- `title` (required): the HTML tag of the article title +- `articleClass`: a class name helping to filter the article element +- `titleClass`: a class name helping to filter the title element +- `section`: the HTML tag encapsulating the group of items. If not given, the entire page will be used +- `content`: the HTML tag encapsulating the content, or description, of the item. The default is `p` +- `contentClass`: a class name helping to filter the content element +- `link`: the HTML tag encapsulating the link to the item. The default is `a`. +- `linkClass`: a class name helping to filter the link element +- `datetime`: the HTML tag encapsulating the date and time of the item. Any date and time format can be used, the parser will try to understand the format. +- `datetimeClass`: a class name helping to filter the datetime element +- `author`: the HTML tag encapsulating the author of the item +- `authorClass`: a class name helping to filter the author element ## Installation