diff --git a/README.md b/README.md index 8409f3d..432d582 100644 --- a/README.md +++ b/README.md @@ -30,4 +30,17 @@ The `install.sh` script performs the following actions: 2. Creates the target directory (`wp-content/plugins/simplerss`) if it doesn't exist. 3. Downloads the `simplerss.php` file into the target directory. 4. Sets the correct permissions for the `simplerss.php` file. -5. Prints a message indicating that the SimpleRss plugin has been installed or updated successfully. \ No newline at end of file +5. Prints a message indicating that the SimpleRss plugin has been installed or updated successfully. + +# How it works: + + The shortcode [simple_rss url="RSS_FEED_URL" items="NUMBER_OF_ITEMS"] will display the feed. + You can embed the shortcode in any post or page to show the feed. + url is the link to the RSS feed. + items is optional (defaults to 5), and it controls the number of feed items to display. + +## Example of usage: + +[simple_rss url="https://example.com/feed" items="3"] + +This will display the latest 3 items from the specified feed. \ No newline at end of file